码迷,mamicode.com
首页 > Windows程序 > 详细

webAPI 自动生成帮助文档

时间:2015-05-27 00:43:07      阅读:264      评论:0      收藏:0      [点我收藏+]

标签:

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

先看一下生成的webapi文档。

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

技术分享

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

技术分享

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

技术分享

 

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

技术分享

 

设置的方法步骤如下:

开发环境VS2012 + MVC4 + WEB API

1、通过NuGet引用Web API Test Client

PM》Install-Package WebApiTestClient

技术分享

 

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

技术分享

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

 

 

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

技术分享

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

4、打开\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/

 

http://blog.sina.com.cn/s/blog_60ba16ed0102v28z.html

webAPI 自动生成帮助文档

标签:

原文地址:http://www.cnblogs.com/chen110xi/p/4532165.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!