PCB WebAPI 接口测试工具与接口文档生成

 我们自己写WebAPI或调用对方系统提供的WebAPI时,测试WebAPI接口工具用哪些工具呢。

这里将3种WebAPI常用到的工具使用说明.主要是讲对第3种WebApiTestClientWebApi 接口测试工具

一.火狐Firefox的RESTClient插件

   下载地址：  https://addons.mozilla.org/zh-CN/firefox/addon/restclient/

       

二.postman工具，谷歌浏览器可以扩展此插件

   下载地址：  https://www.getpostman.com/apps

      

三.Nuget包WebApiTestClientWebApi  接口测试工具

    1.打开【管理Nuget程序包】安装WebApiTestClientWebApi 接口测试工具

       

   

    2.安装完效果 

             

   

    3.在Api.cshtml中最后一段代码中增加以下代码,用途增加WebAPI接口测试按钮

              

              增加代码：

@Html.DisplayForModel("TestClientDialogs")
@section Scripts{
    <link href="~/Areas/HelpPage/HelpPage.css" rel="stylesheet" />
    @Html.DisplayForModel("TestClientReferences")
}

  

    4.在程序集【属性】--》【生成】生成XML方法注释文档，路径APP_Data\WebAPI.xml

             

   

     4.配置读取方法注释文档，路径APP_Data\WebAPI.xml,

      加在HelpPageConfig类中的Register方法最后一行,作用获取接口方法参数描述信息

             

               增加代码：

  config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/WebAPI.XML")));

       

     5.查看接口清单 

              

        

    6.测试接口效果 

                  

   

    7.接口传参描述文档

             

   

     8.小结,采用WebApiTestClientWebApi内嵌WebAPI测试工具,测试确实不错呀

          1.接口测试方便，参数也是一目了然，在调用接口时就可以查看接口参数描述与类型，再也不用边翻接口文档呢。

          2.接口文档清单自动生成,.省去需写接口文档.

        (当然中大型项目为了规范化,接口文档还是必不可少的，因为文档包含的内容更全面,

           如：触发节点,正式与接口地址，调用频次范围，是否异步,传入参数示例,返回参数示例与状态说明,接口版本变更内容等等)