[JAVA]SpringBoot集成Swagger

Swagger简介

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

 官网：https://swagger.io/

在项目使用Swagger需要springbox；

• swagger2
• ui

 SpringBoot集成Swagger

新建一个SpringBoot—web项目

导入相关依赖

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

 编写一个Hello工程

配置Swagger==> Config

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

测试运行：http://localhost:8080/swagger-ui.html

 配置Swagger

Swagger的bean实例 Docket；

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

    //配置了Swagger的Docket的bean实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
    }

    //配置Swagger信息=apiInfo
    private ApiInfo apiInfo(){
        Contact contact = new Contact("灰灰", "https://www.kuangstudy.com/", "@qq.com");

        return new ApiInfo("灰灰的SwaggerAPI文档",
                "好好学习，天天向上",
                "1.0",
                "http://localhost:8081/hello",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList());
    }
}

Swagger配置扫描接口

Docket.select()

//配置了Swagger的Docket的bean实例
@Bean
public Docket docket(){
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            //RequestHandlerSelectors，配置扫描接口的方式
            //basePackage：指定要扫描的包
            //any():扫描全部
            //none():不扫描
            //withClassAnnotation：扫描类上的注解，参数是一个注解的反射对象
            //withMethodAnnotation：扫描方法上的注解
            .apis(RequestHandlerSelectors.basePackage("com.hui.swagger.controller"))
            //paths()：过滤什么路径
            .paths(PathSelectors.ant("/hui/**"))
            .build();
}

配置是否启动Swagger

	//配置了Swagger的Docket的bean实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(false) //enable是否启动Swagger，如果未False，则Swagger不能在浏览器中访问
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.hui.swagger.controller"))
                //.paths(PathSelectors.ant("/hui/**"))
                .build();
    }

我只希望我的Swagger在生产环境中使用，在发布的时候不使用？

• 判断是否是生产环境 flag = false
• 注入enable(falg)

	//配置了Swagger的Docket的bean实例
    @Bean
    public Docket docket(Environment environment){
        //设置要显示的Swagger环境
        Profiles profiles = Profiles.of("dev");//可以填多个值 用逗号分割或者是|分割
        //通过environment.acceptsProfiles判断是否处在自己设定的环境当中
        boolean flag = environment.acceptsProfiles(profiles);
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(flag) //enable是否启动Swagger，如果未False，则Swagger不能在浏览器中访问
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.hui.swagger.controller"))
                //.paths(PathSelectors.ant("/hui/**"))
                .build();
    }

配置Api文档的分组

.groupName("灰灰")

如何配置多个分组，多个Docket实例即可

 	@Bean
    public Docket docket1(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("A");
    }
    @Bean
    public Docket docket2(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("B");
    }
    @Bean
    public Docket docket3(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("C");
    }

实体类配置

package com.hui.swagger.pojo;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
//@Api("注释")
@ApiModel("用户实体类")
public class User {
    @ApiModelProperty("用户名")
    public String username;
    @ApiModelProperty("密码")
    public String password;
}

controller

package com.hui.swagger.controller;
import com.hui.swagger.pojo.User;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class HelloController {
    @GetMapping(value = "/hello")
    public String hello(){
        return "hello";
    }
    //只要我们接口中，返回值中存在实体类，他就会被扫描到Swagger中
    @PostMapping(value = "/user")
    public User user(){
        return new User();
    }
    //Operation接口，不是放在类上的，是放在方法上的
    @ApiOperation("hello控制类")
    @GetMapping(value = "/hello2")
    public String hello2(@ApiParam("用户名")String username){
        return "hello"+username;
    }
    @ApiOperation("Post测试类")
    @GetMapping(value = "/postt")
    public User postt(@ApiParam("用户类")User user){
        int i = 5/0;	//500错误
        return user;
    }
}

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