ASP.NET Web API如何将注释自动生成帮助文档
更新时间：2015年07月20日 17:27:03 作者：dudu
本篇文章主要介绍了ASP.NET Web API从注释自动生成帮助文档的方法，功能很是强大，现与大家分享一下,需要的朋友可以参考下
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。
然后编译项目，就会在对应的路径下生成xml文件。
接着打开 Areas\HelpPage\App_Start\HelpPageConfig.cs 文件，取消 config.SetDocumentationProvider 代码的注释，修改一下路径：
然后重新编译，访问 /help 页面，就能看到效果了。
复制代码 代码如下:
config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/OpenAPI.xml")))
通过以上的简单介绍，希望对大家有所帮助
相关文章
asp.net 读取Excel数据到DataTable的代码
asp.net 读取Excel数据到DataTable的代码，需要的朋友可以参考下。2010-03-03
ASP.NET 2.0下的条件编译...2006-09-09
Log4net在.Net Winform项目中的使用实例详解
Log4net是一个流行的日志记录工具，可以帮助开发人员在应用程序中实现高效的日志记录，本文将提供一个详细的分步骤示例，来帮助您在.Net Winform项目中使用Log4net，感兴趣的朋友一起看看吧2023-08-08
这篇文章介绍了轻量级ORM框架Dapper的安装方法，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2022-03-03
JQuery实现Repeater无刷新批量删除(附后台asp.net源码)
JQuery实现Repeater无刷新批量删除(附后台asp.net源码) ，学习jquery的朋友可以参考下。2011-09-09
asp.net下利用JS实现对后台CS代码的调用方法...2007-04-04
Repeater控件，每个item前有一个CheckBox，把选择的item列显出来,有两个地方需要注意的，就是CheckBox与Label，这个Label是随你需要获取的内容而变化喔。如你想获取Nickname,那你需要把绑定的的内容放在Label上2013-01-01
这篇文章主要为大家详细介绍了Visual Studio 2017安装失败的解决方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2017-04-04
这篇文章介绍了.Net Core静态文件资源的使用方法，文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2022-07-07
ASP.NET网站发布时的那些坑，要小心了，为什么网站发布后，每个页面第一次打开都很卡？ASP.NET session 频繁丢失如何解决？具有一定的参考价值，感兴趣的小伙伴们可以参考一下2017-04-04
最新评论