给WebAPI项目加上一个说明文档以及一个测试按钮

 

首先一般情况下你新建一个webAPI项目后会有一个Areas/HelpPage 的目录存在,这就是webAPI的说明文当的页面

如下图

如果没有:没有关系,打开Nuget包管理器的控制台 输入  Install-Package Microsoft.AspNet.WebApi.HelpPage 完成安装后 你就可以看到上述文件夹了,这一步只是装好了 

展示WEBAPI文档的东东,

下一步安装TestAPI的插件,这个插件会在页面生成一个按钮,点击这个按钮可以直接调试WEBAPI 方便到爆炸。

打开Nuget包管理器的控制台 输入  Install-Package WebApiTestClient  按成安装后多了这两个文件

接下来做一些修改,添加一些代码,找到 Api.cshtml 文件

添加红框中的内容

到此结束,你会发现 WEBAPI的文档说明界面右下角多了一个TestAPI的按钮

然后你会发现一切都是英文,那么怎么显示中文说明呢

首先 选中项目,右键-属性-生成 选择下面的XML文档文件,目录填写如下图所示

然后打开这个文件

取消注释 并修改XML文件路径 完成后如下

然后在API的控制器上的写上 中文注释 就可以显示了。

上述步骤做完后,编译一下你会发现有很多warring ,看着比较烦

 

 禁止显示这个警告就行了。

然后你就可以愉快的调试了,完!

参考链接:

http://www.360doc.com/content/14/0919/09/10504424_410619112.shtml

https://blogs.msdn.microsoft.com/yaohuang1/2012/12/02/adding-a-simple-test-client-to-asp-net-web-api-help-page/

 

推荐使用swagger

posted @ 2017-05-25 00:59  leonxi  阅读(2215)  评论(2编辑  收藏  举报