webAPI 自动生成帮助文档

关于自动生成API帮助文档,以便本地测试

1、通过nuget引用安装:

A:搜索 web api test client 进行安装

webAPI 自动生成帮助文档

B:通过代码安装   Install-Package WebApiTestClient

webAPI 自动生成帮助文档

2、安装后项目会自动添加Areas文件夹和一堆文件

webAPI 自动生成帮助文档

3、App_Data文件夹中新建文件:XmlDocument.xml,什么都不用干,新建就好

webAPI 自动生成帮助文档

4、修改项目属性

webAPI 自动生成帮助文档

到目前位置我们的帮助文档基本就生成好了(下图)

webAPI 自动生成帮助文档

遗憾的是方法的描述信息没有显示出来

5、修改代码显示描述信息

webAPI 自动生成帮助文档

修改此文件

webAPI 自动生成帮助文档

去掉此行注释

搞定,收工!

webAPI 自动生成帮助文档

题外话:

当然可以通过修改api路由规则(WebApiConfig.cs)来改变api显示的结果,比如可以显示为这个样子(增加了action,虽然微软说这样捉不符合人们对webservices的认知,但个人感觉测试什么更方便些,仅供大家参考):

webAPI 自动生成帮助文档

 

webAPI 自动生成帮助文档

上一篇:Qt5的插件机制(7)--插件开发示例代码(Lower-level API)


下一篇:更改Windows命令行字体