13.Swagger

13.Swagger

学习目标

• 了解Swagger的概念及作用

• 掌握在项目中集成Swagger自动生成API文档

13.1Swagger简介

Swagger 是一个规范且完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

Swagger 的目标是对 REST API 定义一个标准且和语言无关的接口，可以让人和计算机拥有无须访问源码、文档或网络流量监测就可以发现和理解服务的能力。当通过 Swagger 进行正确定义，用户可以理解远程服务并使用最少实现逻辑与远程服务进行交互。与为底层编程所实现的接口类似，Swagger 消除了调用服务时可能会有的猜测。

Swagger 的优势

• 支持 API 自动生成同步的在线文档：使用 Swagger 后可以直接通过代码生成文档，不再需要自己手动编写接口文档了，对程序员来说非常方便，可以节约写文档的时间去学习新技术。
• 提供 Web 页面在线测试 API：光有文档还不够，Swagger 生成的文档还支持在线测试。参数和格式都定好了，直接在界面上输入参数对应的值即可在线测试接口。

前后端分离

• 前端 -> 前端控制层、视图层

• 后端 -> 后端控制层、服务层、数据访问层

• 前后端通过API进行交互

• 前后端相对独立。且松耦合

产生的问题

• 前后端集成，前端或者后端无法做到"及时协商，尽早解决"，最终导致问题集中爆发

解决方案

• 首先定义schema【计划的提纲】，并实时跟踪最新的API，降低集成风险

• 早些年指定word计划文件

• 前后端分离：前端测试后端接口：postman

• 后端提供接口，需要实时更新最新的消息以及改动！

Swagger

• 号称世界上最流行的API框架

• Restful 文档在线自动生成器 ==> API文档 与 API定义同步更新

• 直接运行，在线测试API接口（其实就是controller requsetmapping）

• 支持多种语言（如：Java，PHP等）

• 官网：API Documentation & Design Tools for Teams | Swagger

13.2Springboot集成Swagger

SpringBoot集成Swagger => springfox，两个jar包

• Springfox-swagger2

• swagger-springmvc

使用Swagger

要求：jdk 1.8 + 否则swagger2无法运行

步骤：

1、新建一个SpringBoot-web项目

2、添加Maven依赖

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>3.0.0</version>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>3.0.0</version>
        </dependency>

3、编写HelloController，测试确保运行成功！

4、要使用Swagger，我们需要编写一个配置类 SwaggerConfig来配置 Swagger

@Configuration //配置类
@EnableSwagger2 // 开启Swagger2的自动配置
public class SwaggerConfig {
}

5、访问测试 ：http://localhost:8080/swagger-ui.html ，可以看到swagger的界面；

13.2.2配置Swagger

1、Swagger实例Bean是Docket，所以通过配置Docket实例来配置Swagger，通过对象Docket对象接管原来默认的配置

@Bean //配置docket以配置Swagger具体参数
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2);
}

2、可以通过apiInfo()属性配置文档信息

/ 可以通过apiInfo()属性配置文档信息
    private ApiInfo apiInfo(){
        Contact contact = new Contact("联系人名字", "http://xxx.xxx.com/联系人访问链接", "联系人邮箱");
        return new ApiInfo(
                "Swagger学习", //标题
                "学习演示如何配置Swagger",
                "v1.0", //版本
                "http://terms.servlet.url/组织链接", //组织链接
                contact, //联系人信息
                "Apach 2.0 许可", //许可
                "许可链接", //许可链接
                new ArrayList<>() //扩展
        );
    }

3、Docket 实例关联上 apiInfo()

    @Bean
    //配置docket以配置Swagger具体参数
    //Docket实例关联上apiInfo()
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
    }

13.2.3配置扫描接口

1、构建Docket时通过select()方法配置怎样扫描接口

    @Bean
    //配置docket以配置Swagger具体参数
    //Docket实例关联上apiInfo()
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.kuang.controller"))
                .build();//通过select方法，去配置扫描接口，RequestHandlerSelectors配置如何扫描接口
    }

2、重启项目测试，由于我们配置根据包的路径扫描接口，所以我们只能看到一个类

3、除了通过包路径配置扫描接口外，还可以通过配置其他方式扫描接口，这里注释一下所有的配置方式：

any() // 扫描所有，项目中的所有接口都会被扫描到
none() // 不扫描接口
// 通过方法上的注解扫描，如withMethodAnnotation(GetMapping.class)只扫描get请求
withMethodAnnotation(final Class<? extends Annotation> annotation)
// 通过类上的注解扫描，如.withClassAnnotation(Controller.class)只扫描有controller注解的类中的接口
withClassAnnotation(final Class<? extends Annotation> annotation)
basePackage(final String basePackage) // 根据包路径扫描接口
paths(PathSelectors.ant("/guo/**"))  //过滤什么路径：过滤/guo下的所有路径

4、除此之外，我们还可以配置接口扫描过滤

    @Bean
    //配置docket以配置Swagger具体参数
    //Docket实例关联上apiInfo()
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.kuang.controller"))
                .paths(PathSelectors.ant("/kuang/**"))
                .build();//通过select方法，去配置扫描接口，RequestHandlerSelectors配置如何扫描接口
    }

5、这里的可选值有

any() // 任何请求都扫描
none() // 任何请求都不扫描
regex(final String pathRegex) // 通过正则表达式控制
ant(final String antPattern) // 通过ant()控制

13.2.4配置Swagger开关

可以指定相应的环境是否开启swagger功能

1、通过enable()方法配置是否启用swagger，如果是false，swagger将不能在浏览器中访问了

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .enable(false) //配置是否启用Swagger，如果是false，在浏览器将无法访问
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))
       // 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口
      .paths(PathSelectors.ant("/kuang/**"))
      .build();
}

2、如何动态配置当项目处于test、dev环境时显示swagger，处于prod时不显示？

    @Bean
    //配置docket以配置Swagger具体参数
    //Docket实例关联上apiInfo()
    public Docket docket(Environment environment){
        // 设置要显示swagger的环境
        Profiles of = Profiles.of("dev", "test");

        //判断当前是否处于该环境
        // 通过enable() 接收此参数判断是否要显示
        boolean flag = environment.acceptsProfiles(of);

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(flag) // 配置是否启用Swagger，如果是false，在浏览器将无法访问
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.kuang.controller"))
                .paths(PathSelectors.ant("/kuang/**"))
                .build();//通过select方法，去配置扫描接口，RequestHandlerSelectors配置如何扫描接口
    }

3、可以在项目中增加一个dev的配置文件查看效果！

13.2.5配置API分组

1、如果没有配置分组，默认是default，通过groupName()方法即可配置分组

@Bean
public Docket docket(Environment environment) {
   return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
      .groupName("hello") // 配置分组
       // 省略配置....
}

2、重启项目查看分组

3、如何配置多个分组？配置多个分组只需要配置多个docket即可：

@Bean
public Docket docket1(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("group1");
}
@Bean
public Docket docket2(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("group2");
}
@Bean
public Docket docket3(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("group3");
}

4、重启项目查看即可

13.2.6实体配置

1、新建一个实体类

@ApiModel("用户实体")
public class User {
   @ApiModelProperty("用户名")
   public String username;
   @ApiModelProperty("密码")
   public String password;
}

2、只要这个实体在请求接口的返回值上（即使是泛型），都能映射到实体项中：

@RequestMapping("/getUser")
public User getUser(){
   return new User();
}

3、重启查看测试

注：并不是因为@ApiModel这个注解让实体显示在这里了，而是只要出现在接口方法的返回值上的实体都会显示在这里，而@ApiModel和@ApiModelProperty这两个注解只是为实体添加注释的。

@ApiModel为类添加注释

@ApiModelProperty为类属性添加注释

13.3常用注解

Swagger的所有注解定义在io.swagger.annotations包下

下面列出一些常用的，未列举出来的可以另行查阅说明：

我们也可以给请求的接口配置一些注释

@ApiOperation("这是一个接口")
@PostMapping("/guo")
@ResponseBody
public String guo(@ApiParam("这个名字会被返回")String username){
   return username;
}

这样的话，可以给一些比较难理解的属性或者接口，增加一些配置信息，让人更容易阅读！

相较于传统的Postman或Curl方式测试接口，使用swagger简直就是傻瓜式操作，不需要额外说明文档(写得好本身就是文档)而且更不容易出错，只需要录入数据然后点击Execute，如果再配合自动化框架，可以说基本就不需要人为操作了。

Swagger是个优秀的工具，现在国内已经有很多的中小型互联网公司都在使用它，相较于传统的要先出Word接口文档再测试的方式，显然这样也更符合现在的快速迭代开发行情。当然了，提醒下大家在正式环境要记得关闭Swagger，一来出于安全考虑二来也可以节省运行时内存。

最后我学会的：

①给swagger中添加注释 ②修改页面的标题等内容 ③简单的操作一些请求测试