首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >webAPI 自动生成帮助文档

webAPI 自动生成帮助文档

作者头像
写代码的猿
发布2019-04-11 14:41:08
2K0
发布2019-04-11 14:41:08
举报
文章被收录于专栏:平凡少年平凡少年

之前在项目中有用到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

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

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

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

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

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

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

本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
原始发表:2014-08-22 ,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档