当前位置:首页 > Windows程序 > 正文

WEBAPI 自动生成帮助文档

2021-05-24 Windows程序

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

WEBAPI 自动生成帮助文档

温馨提示: 本文由Jm博客推荐,转载请保留链接: https://www.jmwww.net/file/70375.html