Swagger

学习目标

了解Swagger的作用和概念
了解前后端分离
在Springboot中集成Swagger

Swagger简介

前后端分离

Vue+Spring boot

后端时代：前端只用管理静态页面；html==>后端。模板引擎 JSP=>后端是主力

前后端分离式时代：

后端：后端控制层，服务层，数据访问层【后端团队】
前端：前端控制层，视图层【前端团队】
- 伪造后端数据，json，已经存在了，不需要后端，前端工程依旧能够跑起来
前后端如何交互?===>API
前后端甚至可以部署在不同的服务器上

产生一个问题：

前后端集成联调，前端人员和后端人员无法做到"即时协商，尽早解决"，最终导致问题集中爆发；

解决方案：

首先指定schema $计划的提纲$ ，实时更新最新API，降低集成风险；
早些年，制定word计划文档；git
前后端分离：
- 前端测试后端接口：postman
- 后端提供接口，需要实时更新最新的消息及改动！

Swagger

号称世界上最流行的API框架
RestFul Api 文档在线自动生成工具=>Api文档与Api定义同步更新
直接运行，可以在线测试API接口；
支持多种语言：(java，php.....)

官网：自己百度

在项目使用Swagger需要springbox；

springger2
ui

SpringBoot 集成Swagger

新建一个SpringBoot项目

导入相关依赖

XML 复制代码

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>3.0.0</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>3.0.0</version>
        </dependency>
<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>

编写一个Hello工程

java 复制代码

package com.chen.swagger.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {
    @RequestMapping("/hello")
    @ResponseBody
    public String hello(){
        return "hello";
    }
}

配置Swagger==>config

java 复制代码

package com.chen.swagger.config;

import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2 //开启Swagger2
public class SwaggerConfig {
}

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

配置Swagger

Swagger实例Bean是Docket，所以通过配置Docket实例来配置Swagger

java 复制代码

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

可以通过apilnfo()属性配置文档信息

java 复制代码


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

Docket实例关联上 apilnfo()

java 复制代码

@Bean
public Docket docket() {
    return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
}

重启项目，访问测试 http://localhost:8080/swagger-ui/index.html 看下效果；

配置扫描接口

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

java 复制代码

@Bean
    public Docket docket(Environment environment){
        //获取项目环境
        //设置要显示的swagger环境
        Profiles of = Profiles.of("dev", "test");
        //通过environment.acceptsProfiles判断是否处在自己设定的环境当中
        boolean b = environment.acceptsProfiles(of);


        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //.enable(false) enable是否启动swagger 如果为false 则swagger不能在浏览器中访问
                .enable(b)
                // 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
                .select()
                //RequestHandlerSelector:配置扫描接口的方式
                //basePackage:指定要扫描的包
                //any():扫描全部
                //none():不扫描
                //withClassAnnotation:扫描类上的注解,参数是一个注解的反射对象
                //withMethodAnnotation:扫描方法上的注解
                .apis(RequestHandlerSelectors.basePackage("com.chen.controller"))
                //.paths() 过滤什么路径
                .build();
    }

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

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

java 复制代码

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) // 根据包路径扫描接口

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

java 复制代码

@Bean
public Docket docket() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
        .apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))
        // 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口
        .paths(PathSelectors.ant("/kuang/**"))
        .build();
}

这里的可选值还有

java 复制代码

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

问题：当我的Swagger我想在开发中展示

我们需要设置两个环境：

spring.profile.active="dev" server.port=8081 开发环境

server.port=8080

java 复制代码

//获取项目环境
        //设置要显示的swagger环境
        Profiles of = Profiles.of("dev", "test");
        //通过environment.acceptsProfiles判断是否处在自己设定的环境当中
        boolean b = environment.acceptsProfiles(of);


        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //.enable(false) enable是否启动swagger 如果为false 则swagger不能在浏览器中访问
                .enable(b)

配置API分组

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

java 复制代码

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

重启项目查看分组

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

java 复制代码

@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");
}

实体配置

新建实体类

java 复制代码

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

只要这个实体在请求接口的返回值上(即使是泛型)，都能映射到实体项中
java 复制代码
```
@RequestMapping("/getUser")
public User getUser(){
    return new User();
}
```
重启查看测试

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

@ApiModel为类添加注释

@ApiModelProperty为类属性添加注释

常用注解

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

下面列一些经常使用的，未列举可以自己看：

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

java 复制代码

@ApiOperation("狂神的接口")
@PostMapping("/kuang")
@ResponseBody
public String kuang(@ApiParam("这个名字会被返回")String username){
    return username;
}

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

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

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

总结：

我们可以通过通过Swagger给一些比较难理解的属性或者接口，增加注释信息
接口文档实时更新
可以在线测试

正式环境要记得关闭Swagger