webAPI 自动生成帮助文档

以前在项目中有用到webapi对外提供接口，发如今项目中有根据webapi的方法和注释自动生成帮助文档，还能够测试webapi方法，功能非常强大，现拿出来与你们分享一下。

先看一下生成的webapi文档。

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

二、点击红框内的连接，打开api方法的详情页面，以下图所示，

三、点击Test API打开以下页面

 

四、输入参数，点击Send按钮，打开以下页面，能够看到返回值。

 

设置的方法步骤以下：

开发环境VS2012 + MVC4 + WEB API

一、经过NuGet引用Web API Test Client

 

引用玩该DLL会生成以下文件：

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

 

 

二、在项目属性中进行以下设置，勾选XMl文档文件，并设置路径

三、在项目的App_Data文件夹下建立XmlDocument.xml

四、打开\Areas\HelpPage\App_Start\HelpPageConfig.cs文件，取消以下代码注释

 

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

点击下载项目代码

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