ASP.NET Web API如何将注释自动生成帮助文档
作者: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")))
通过以上的简单介绍,希望对大家有所帮助