首页 > Windows开发 > 详细

启用WebApi 2里的Api描述信息(Help下的Description)

时间:2016-06-25 17:50:16      阅读:384      评论:0      收藏:0      [点我收藏+]

环境:vs2013+web api 2

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

技术分享

解决:

1.先启用输出的XML文档文件:

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

技术分享

2.在"解决方案管理器"里,打HelpPageConfig.cs,去掉SetDocumentationProvider方法,并把地址改成与1里的对应,如下图所示:

技术分享

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

技术分享

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

技术分享

 

参考:ASP.NET Web API Help Page documentation using Xml comments on controllers

启用WebApi 2里的Api描述信息(Help下的Description)

原文:http://www.cnblogs.com/kid1412/p/5616494.html

(0)
(0)
   
举报
评论 一句话评论(0
关于我们 - 联系我们 - 留言反馈 - 联系我们:wmxa8@hotmail.com
© 2014 bubuko.com 版权所有
打开技术之扣,分享程序人生!