专栏首页平凡少年webAPI 自动生成帮助文档

webAPI 自动生成帮助文档

之前在项目中有用到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文档,即该篇文章的一张图片

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 创建链接服务器(dblink)

    写代码的猿
  • 一致性Hash算法在Redis分布式中的使用

    由于redis是单点,但是项目中不可避免的会使用多台Redis缓存服务器,那么怎么把缓存的Key均匀的映射到多台Redis服务器上,且随着缓存服务器的增加或减...

    写代码的猿
  • 使用InstallUtil发布windows服务

       a)ServiceName =”FirstService”;   //设置服务名称

    写代码的猿
  • 微服务模式系列之三:API网关

    译者自序: 熟悉我的朋友都知道,我很不喜欢翻译东西,因为在两种语言的思维方式之间做频繁切换对我来说是件很痛苦的事情。但是这次不一样,公司和同事的大力支持降低了我...

    yuanyi928
  • 我国域名注册保有量位居世界第二,顶级域名55个

    近日,来自中国信息通信研究院的数据显示,截止2017年年底,我国域名注册保有量约5000万,位居世界第二。比2016年增长20%。其中,国家与地区代码...

    躲在树上的域小名
  • web前端网站收藏

    Joel
  • 写4点宝贵的经验,给初入职场的你

    初入职场的时候,没有人给我讲应该注意哪些,也不知道去知乎上找答案,就那样傻乎乎地自我摸索总结。结果犯了不少致命的错误,这里回忆一些供你借鉴。

    沉默王二
  • 响铃:商业模式的护城河,才是美团的边界

    小米IPO估值终于尘埃落地,17港元/股的下限定价、539亿美元的“底线”估值。虽说小米对外放风这是在目前全球股市不太顺利的情况下为了“预留获利空间,也降低破...

    曾响铃
  • SFFAI分享 | 周龙:同步双向文本生成【附PPT与视频资料】

    基于双向编码的BERT在11项自然语言理解任务上取得了惊人的效果,而目前主流的自然语言生成任务(包括机器翻译,自动摘要等)仍然采用单向解码,即从左到右依次产生目...

    马上科普尚尚
  • 如何保证ERP系统在上线后运营稳定?

      大家以为从此以后可以松口气,但事实恰恰相反。原来攻坚战组成的组员陆续回到原来的部门,ERP项目组只剩下IT部门的人,“攻坚战”的胜利很快遭到了质疑。因为新系...

    用户5495712

扫码关注云+社区

领取腾讯云代金券