WEBAPI 自动生成帮助文档

转载于 2015-06-29 17:59:00 发布 · 70 阅读

CC 4.0 BY-SA版权

原文链接：http://www.cnblogs.com/shya/p/4608183.html

在WEB API开发中，通过安装Microsoft.AspNet.WebApi.HelpPage包，配置项目属性以生成XML文档文件，并在HelpPageConfig.cs文件中设置文档提供者，实现从API注释自动生成API帮助文档的功能。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

需求来源

WEBAPI开发过程中发现一个蛋疼的问题，给其他人员使用的时候还得整理文档，而API函数本身是有注释的，于是想到可以利用注释生成API帮助文档。

1、安装Microsoft.AspNet.WebApi.HelpPage

Install-Package Microsoft.AspNet.WebApi.HelpPage

2、选中项目，右键，属性，生成，选择下面的XML 文档文件，目录自己填写，如下图：

3、找到 Areas/HelpPage/App_Start 目录下的HelpPageConfig.cs 文件，Register 方法，添加一行代码：

 config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/Areas/HelpPage/WebApiHelp.XML")));

4、重新生成然后访问即可

http://xxx.com/Help

转载于:https://www.cnblogs.com/shya/p/4608183.html