webAPI 自动生成帮助文档

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

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

或者通过Nuget控制台输入Install-Package WebApiTestClient

 

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

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

 

 

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

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

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

 

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

PS:在错误和警告-禁止显示警告填上1591,即可不显示缺少对公共可见类型或成员****的xml注释

转载于:https://www.cnblogs.com/varorbc/p/4453442.html

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值