.net WebApi 文档注释

默认情况下新建的Web Api 2项目,自带的Help页下会显示Api的相关信息,但Description那一栏无法获取到数据,如下图所示:

.net WebApi 文档注释_第1张图片
解决方式:1.先启用输出的XML文档文件:

在web api 项目上右击->属性,在属性页"生成"标签下,勾选输出下面的"XML 文档文件",如下图所示:

.net WebApi 文档注释_第2张图片

2.在项目里,打HelpPageConfig.cs,去掉SetDocumentationProvider方法,并把地址改成与1里的对应,如下图所示:

.net WebApi 文档注释_第3张图片

3.在Api上添加注释,如下图所示:


.net WebApi 文档注释_第4张图片

再次运行项目,打开Api Help页面,就可以看到效果了,如下图所示:


.net WebApi 文档注释_第5张图片
.net WebApi 文档注释_第6张图片

你可能感兴趣的:(.net WebApi 文档注释)