码迷,mamicode.com
首页 > Windows程序 > 详细

ASP.NET Web API从注释生成帮助文档

时间:2016-04-14 22:01:11      阅读:234      评论:0      收藏:0      [点我收藏+]

标签:

ASP.NET Web API从注释生成帮助文档

默认情况下,ASP.NET Web API不从Controller的注释中生成帮助文档。如果要将注释作为Web API帮助文档的一部分,比如在帮助文档的Description栏目中显示方法注释中的summary,需要进行一些配置操作。

首先在Visual Studio中打开Web API项目的属性页,在Build设置页,选中XML document file,输入将要生成的XML文件放置的路径,比如:App_Data\OpenAPI.XML。

技术分享

1460637926036.jpg

然后编译项目,就会在对应的路径下生成xml文件。

接着打开 Areas\HelpPage\App_Start\HelpPageConfig.cs 文件,取消 config.SetDocumentationProvider 代码的注释,修改一下路径:

config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/OpenAPI.xml")));

然后重新编译,访问 /help 页面,就能看到效果了。

ASP.NET Web API从注释生成帮助文档

标签:

原文地址:http://www.cnblogs.com/ypfnet/p/5392683.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!