使用swagger实现web api在线接口文档

Posted 2020-09-10 我是攻城狮

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了使用swagger实现web api在线接口文档相关的知识，希望对你有一定的参考价值。

一、前言

　　通常我们的项目会包含许多对外的接口，这些接口都需要文档化，标准的接口描述文档需要描述接口的地址、参数、返回值、备注等等；像我们以前的做法是写在word/excel，通常是按模块划分，例如一个模块包含n个接口，就形成一个文档，然后再用版本控制管理。这样做的缺点是：

1.不够直观，每次打开文档查看接口很麻烦

2.文档的维护难度大

3.调用方和测试人员使用麻烦，需要先去找接口，在用相应的工具测试（例如使用浏览器还可能要安装插件）

　　我们希望是可以直接在线浏览，然后直接用浏览器测试。而接口的详细描述都在程序里用注释完成。swagger就可以完成这个工作（ps好像很多开发人员都还不知道这个东西。。。）。

二、使用Swagger

　　Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。

　　在web api 使用swagger可以说非常简单，不需要编写任何代码，完全依赖于插件。具体步骤如下：

　 1.新建一个web api项目

　　2.使用nuget添加Swashbuckle包

　　3.完成

　　没错，就是这么简单！运行项目，转到地址 http://localhost:57700/swagger/ui/index 会看到如下页面，这是默认添加的两个apicontroller：　　

　　这个时候接口还没有具体的描述信息等，例如我们给ValuesController.Get添加注释描述，在页面上还是没有显示出来。需要按照如下步骤实现：

　　1. 在app_start 下 SwaggerConfig 大100行的位置找到 //c.IncludeXmlComments(GetXmlCommentsPath()); 如下注释，改为：c.IncludeXmlComments(GetXmlCommentsPath(thisAssembly.GetName().Name)); （注意去掉注释了）

　　2. 在SwaggerConfig添加一个方法代码：

        protected static string GetXmlCommentsPath(string name)
        {
            return string.Format(@"{0}\\bin\\{1}.XML", AppDomain.CurrentDomain.BaseDirectory, name);
        }

　　3. 修改项目生成，在bin下对应的xml文件可以看到具体的描述文档，如下：

　　重新生成项目，就要可以看到完整的接口描述了。例如我们心中一个TestController如下：

    /// <summary>
    /// 测试控制器
    /// </summary>
    public class TestController : ApiController
    {
        /// <summary>
        /// 测试Get方法
        /// </summary>
        /// <remarks>测试Get方法</remarks>
        /// <returns></returns>
        [HttpGet]
        public string Get()
        {
            return "Get";
        }

        /// <summary>
        /// 测试Post方法
        /// </summary>
        /// <param name="name">姓名</param>
        /// <param name="age">年龄</param>
        /// <remarks>测试Post方法</remarks>
        /// <returns></returns>
        [HttpPost]
        public string Post(string name, int age)
        {
            return name + age.ToString();
        }
    }

　　生成的页面如下，可以看到接口的描述，点击Try it out 即可调用：

三、非依赖代码

　　上面的方式依赖于Swashbuckle包，它已经包含了Swagger-UI组件。我们的代码需要引入这个包，实际上也可以不需要在项目中引入，单独部署Swagger,包括Swagger-Ui（api展示）和 Swagger-Editor（在线编辑器），它需要依赖nodejs环境，所以需要先按照nodejs。部署其实也很简单，例如这是我部署的结果：

　　swagger-editor:　　