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 Web API如何将注释自动生成帮助文档到此结束。懂得感恩,是收获幸福的源泉。懂得感恩,你会发现原来自我周围的一切都是那样的完美。小编再次感谢大家对我们的支持!

标签: 自动生成