Web API 自动生成帮助文档并使用Web API Test Client 测试

时间:2023-11-21 16:57:56

之前在项目中有用到webapi对外提供接口,发现在项目中有根据webapi的方法和注释自动生成帮助文档,还可以测试webapi方法,功能很是强大,现拿出来与大家分享一下。

先看一下生成的webapi文档。

1、下图展示的是生成帮助文档首页面,其中Values是controller,API下面的列表展示出请求的http方法(Get,POST等),请求的action,方法的描述。

Web API 自动生成帮助文档并使用Web API Test Client 测试

2、点击红框内的链接,打开api方法的详情页面,如下图所示,

Web API 自动生成帮助文档并使用Web API Test Client 测试

3、点击Test API打开如下页面

Web API 自动生成帮助文档并使用Web API Test Client 测试

4、输入参数,点击Send按钮,打开如下页面,可以看到返回值。

Web API 自动生成帮助文档并使用Web API Test Client 测试

设置的方法步骤如下:

开发环境VS2012 + MVC4 + WEB API

1、通过NuGet引用Web API Test Client

Web API 自动生成帮助文档并使用Web API Test Client 测试

引用玩该DLL会生成如下文件:

Web API 自动生成帮助文档并使用Web API Test Client 测试

这里面就是我们的帮助文档界面

2、在项目属性中进行如下设置,勾选XMl文档文件,并设置路径

Web API 自动生成帮助文档并使用Web API Test Client 测试

3、在项目的App_Data文件夹下创建XmlDocument.xml

4、打开\Areas\HelpPage\App_Start\HelpPageConfig.cs文件,取消如下代码注释

Web API 自动生成帮助文档并使用Web API Test Client 测试

运行项目,打开http://localhost:3619/Help,即可看到自动生成好的api文档,即该篇文章的一张图片

点击下载项目代码

参考:http://www.c-sharpcorner.com/UploadFile/2b481f/adding-the-test-api-in-the-Asp-Net-web-api-help-page/