简介

号称世界上最流行的Api框架
RestFul Api文档在线自动生成工具 Api文档与API定义同步更新

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

• Springfox-swagger2
• springfox-swagger-ui

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

相较于传统的Postman或Curl方式测试接口，使用swagger简直就是傻瓜式操作，不需要额外说明文档(写得好本身就是文档)而且更不容易出错，只需要录入数据然后点击Execute，如果再配合自动化框架，可以说基本就不需要人为操作了。
Swagger是个优秀的工具，现在国内已经有很多的中小型互联网公司都在使用它，相较于传统的要先出Word接口文档再测试的方式，显然这样也更符合现在的快速迭代开发行情。
当然了，提醒下大家在正式环境要记得关闭Swagger，一来出于安全考虑二来也可以节省运行时内存。

Springboot集成Swagger

导入相关依赖

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

开启Swagger

创建config类

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

测试

配置Swagger

@Configuration
@EnableSwagger2 //开启Swagger2
public class SwaggerConfig {
    //配置Swagger的Docker的bean实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo());
    }
    //配置Swagger信息 apiInfo
    private ApiInfo apiInfo() {
        //作者信息  "联系人名字", "联系人访问链接", "联系人邮箱"
        Contact contact = new Contact("拾贰s", "https://www.yuque.com/shiers", "1173919359@qq.com");
        return new ApiInfo(
            "拾贰s的Swagger文档",  // 标题
            "阿巴阿巴阿巴~👻", // 描述
            "v1.2", // 版本
            "https://www.yuque.com/shiers", // 组织链接
            contact, // 联系人信息
            "Apache 2.0", // 许可
            "http://www.apache.org/licenses/LICENSE-2.0", // 许可连接
            new ArrayList() // 扩展
        );
    }
}

配置扫描接口

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

//配置Swagger的Docker的bean实例
@Bean
public Docket docket() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
        .apis(RequestHandlerSelectors.basePackage("com.shiers.playspring.swagger.controller"))
        .build();
}

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) // 根据包路径扫描接口 👈上面用的这种方法

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

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

5、这里的可选值还有

any() // 任何请求都扫描 👈上面用的这种方法
none() // 任何请求都不扫描
regex(final String pathRegex) // 通过正则表达式控制
ant(final String antPattern) // 通过ant()控制

配置Swagger动态开关

//application.properties
spring.profiles.active=dev   //👈指定当前环境位dev
//application-dev.properties
server.port=8080
//application-pro.properties
server.port=8081

//配置Swagger的Docker的bean实例
@Bean
public Docket docket(Environment environment) {
    // 设置要显示swagger的环境
    Profiles of = Profiles.of("dev", "test");  //环境为dev、test时开启
    // 判断当前是否处于该环境
    // 通过environment.acceptsProfiles是否处于自己设定的环境中
    boolean flag = environment.acceptsProfiles(of);
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .enable(flag) //配置是否启用Swagger，如果是false，在浏览器将无法访问,不写默认true
        .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
        .apis(RequestHandlerSelectors.basePackage("com.shiers.playspring.swagger.controller"))
        // 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口
        //.paths(PathSelectors.ant("/admin/**"))
        .build();
}

配置API分组

其实就是配置多个Docket 通过groupName()方法

@Bean
public Docket docket1(){
    return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).groupName("用户服务");
}
@Bean
public Docket docket2(){
    return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).groupName("视频接口");
}
@Bean
public Docket docket3(){
    return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).groupName("订单服务");
}
@Bean
public Docket docket4(){
    return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).groupName("测试小组");
}

实体配置

@RestController
public class HelloController {
    @RequestMapping("/helloSwagger")
    public String helloSwagger(){
        return "helloSwagger";
    }
    @RequestMapping("/getUser")
    public User getUser(){
        return new User();
    }
}

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

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

常用注解

Swagger的所有注解定义在io.swagger.annotations包下
下面列一些经常用到的，未列举出来的可以另行查阅说明：

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

@Api(tags = "Hello控制类")
@RestController
public class HelloController {
    @RequestMapping(value = "/helloSwagger",method = RequestMethod.GET)
    public String helloSwagger(){
        return "helloSwagger";
    }
    @ApiOperation("接口-用户名获取")
    @GetMapping("/hello/username")
    public String helloUserName(@ApiParam("参数-用户名") String userName){
        return userName;
    }
    @ApiOperation("接口-用户获取")
    @PostMapping ("/hello/user")
    public User user(@ApiParam("参数-用户名") User user){
        return user;
    }
}

拓展：其他皮肤

我们可以导入不同的包实现不同的皮肤定义：

推荐knife4j
官方：

knife4j是springfox-swagger的增强UI实现，为Java开发者在使用Swagger的时候，提供了简洁、强大的接口文档体验。knife4j完全遵循了springfox-swagger中的使用方式，并在此基础上做了增强功能，如果你用过Swagger，你就可以无缝切换到knife4j。

<!-- 整合Knife4j -->
<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>knife4j-spring-boot-starter</artifactId>
   <version>2.0.4</version>
</dependency>

在Swagger2Config中增加一个@EnableKnife4j注解，该注解可以开启knife4j的增强功能；

@Configuration
@EnableSwagger2
@EnableKnife4j  //👈👈👈这个增强功能
public class Swagger2Config {
}

访问地址：http://localhost:8080/doc.html

1、默认的 访问 http://localhost:8080/swagger-ui.html

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

2、bootstrap-ui 访问 http://localhost:8080/doc.html

<!-- 引入swagger-bootstrap-ui包 /doc.html-->
<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.9.1</version>
</dependency>

3、Layui-ui 访问 http://localhost:8080/docs.html（Layui这个访问不到就很坑，需要改配置）

<!-- 引入swagger-ui-layer包 /docs.html-->
<dependency>
   <groupId>com.github.caspar-chen</groupId>
   <artifactId>swagger-ui-layer</artifactId>
   <version>1.1.3</version>
</dependency>

4、mg-ui 访问 http://localhost:8080/document.html

<!-- 引入swagger-ui-layer包 /document.html-->
<dependency>
   <groupId>com.zyplayer</groupId>
   <artifactId>swagger-mg-ui</artifactId>
   <version>1.0.6</version>
</dependency>