webAPI自动生成帮助文档

整理文档很辛苦,赏杯茶钱您下走!

免费阅读已结束,点击下载阅读编辑剩下 ...

阅读已结束,您可以下载文档离线阅读编辑

资源描述

webAPI自动生成帮助文档之前在项目中有用到webapi对外提供接口,发现在项目中有根据webapi的方法和注释自动生成帮助文档,还可以测试webapi方法,功能很是强大,现拿出来与大家分享一下。先看一下生成的webapi文档。1、下图展示的是生成帮助文档首页面,其中Values是controller,API下面的列表展示出请求的http方法(Get,POST等),请求的action,方法的描述。2、点击红框内的链接,打开api方法的详情页面,如下图所示,3、点击TestAPI打开如下页面4、输入参数,点击Send按钮,打开如下页面,可以看到返回值。设置的方法步骤如下:开发环境VS2012+MVC4+WEBAPI1、通过NuGet引用WebAPITestClient引用玩该DLL会生成如下文件:这里面就是我们的帮助文档界面2、在项目属性中进行如下设置,勾选XMl文档文件,并设置路径3、在项目的App_Data文件夹下创建XmlDocument.xml4、打开\Areas\HelpPage\App_Start\HelpPageConfig.cs文件,取消如下代码注释

1 / 8
下载文档,编辑使用

©2015-2020 m.777doc.com 三七文档.

备案号:鲁ICP备2024069028号-1 客服联系 QQ:2149211541

×
保存成功