.net WebApi 文档注释

2016-11-21  本文已影响32人  bbmm

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

解决方式:1.先启用输出的XML文档文件:

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


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

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

上一篇下一篇

猜你喜欢

热点阅读