SpringBoot 集成 Swagger2 接口文档

1. pom.xml 添加 Maven 依赖

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

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>1.8.9</version>
</dependency>

2. 创建 Swagger2Configuration.java

@Configuration
@EnableSwagger2
public class Swagger2Config {
    
    

    @Bean
    public Docket createRestApi() {
    
    
        return new Docket(DocumentationType.SWAGGER_2)
                // 用来创建该API的基本信息，展示在文档的页面中（自定义展示的信息）
                .apiInfo(apiInfo())
                // 设置哪些接口暴露给Swagger展示
                .select()
                // 扫描所有有注解的api，用这种方式更灵活
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build()
                /* 设置安全模式，swagger可以设置访问token */
                .securitySchemes(securitySchemes())
                .securityContexts(securityContexts());
    }

    /**
     * 安全模式，这里指定token通过Authorization头请求头传递
     */
    private List<ApiKey> securitySchemes() {
    
    
        List<ApiKey> apiKeyList = new ArrayList<ApiKey>();
        apiKeyList.add(new ApiKey("Authorization", "Authorization", "header"));
        return apiKeyList;
    }

    /**
     * 安全上下文
     */
    private List<SecurityContext> securityContexts() {
    
    
        List<SecurityContext> securityContexts = new ArrayList<>();
        securityContexts.add(
                SecurityContext.builder()
                        .securityReferences(defaultAuth())
                        //通过PathSelectors.regex("^(?!auth).*$")，所有包含"auth"的接口不需要使用securitySchemes。即不需要使用上文中设置的名为“Authorization”，type为“header”的参数。
                        .forPaths(PathSelectors.regex("^(?!auth).*$"))
                        .build());
        return securityContexts;
    }

    /**
     * 默认的安全上引用
     */
    private List<SecurityReference> defaultAuth() {
    
    
        AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
        AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
        authorizationScopes[0] = authorizationScope;
        List<SecurityReference> securityReferences = new ArrayList<>();
        securityReferences.add(new SecurityReference("Authorization", authorizationScopes));
        return securityReferences;
    }

    /**
     * 添加摘要信息
     */
    private ApiInfo apiInfo() {
    
    
        // 用ApiInfoBuilder进行定制
        return new ApiInfoBuilder()
                // 设置标题
                .title("标题：系统_接口文档")
                // 描述
                .description("描述：")
                // 作者信息
                .contact(new Contact("FerryC", null, null))
                // 版本
                .version("版本号:1.0.0")
                .build();
    }
}

3.API 接口编写

3.1注解说明

@Api：用在请求的类上，表示对类的说明
    tags="说明该类的作用，可以在UI界面上看到的注解"
    value="该参数没什么意义，在UI界面上也看到，所以不需要配置"

@ApiOperation：用在请求的方法上，说明方法的用途、作用
    value="说明方法的用途、作用"
    notes="方法的备注说明"

@ApiImplicitParams：用在请求的方法上，表示一组参数说明
    @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
        name：参数名
        value：参数的汉字说明、解释
        required：参数是否必须传
        paramType：参数放在哪个地方
            · header --> 请求参数的获取：@RequestHeader
            · query --> 请求参数的获取：@RequestParam
            · path（用于restful接口）--> 请求参数的获取：@PathVariable
            · body--> 请求参数的获取：@RequestBody(代码中接收注解)
            · form（不常用）    
        dataType：参数类型，默认String，其它值dataType="Integer"       
        defaultValue：参数的默认值

@ApiResponses：用在请求的方法上，表示一组响应
    @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
        code：数字，例如400
        message：信息，例如"请求参数没填好"
        response：抛出异常的类

@ApiModel：用于响应类上，表示一个返回响应数据的信息
            （这种一般用在post创建的时候，使用@RequestBody这样的场景，
            请求参数无法使用@ApiImplicitParam注解进行描述的时候）
    @ApiModelProperty：用在属性上，描述响应类的属性

3.2 接口定义

@RestController
@Api(tags = "测试接口")
@RequestMapping("/test")
public class TestCotroller {
    
    

    @ApiOperation(value = "测试一", notes = "测试demo1")
    @ApiImplicitParams({
    
    
            @ApiImplicitParam(name = "name", value = "名称", required = true, defaultValue = "", dataType = "String", paramType = "query")
    })
    @GetMapping("/test1")
    public RespData<Stu> test(String name) {
    
    
        RespData respData = new RespData();
        respData.setData(null);
        return respData;
    }

    @ApiOperation(value = "测试二", notes = "测试demo2")
    @PostMapping("/test2")
    public RespData<Stu> test2(@RequestBody Stu stu) {
    
    
        RespData respData = new RespData();
        respData.setData(new Stu());
        return respData;
    }

    @ApiOperation(value = "测试三", notes = "测试demo3")
    @PostMapping("/tests/{id}")
    public RespData<Clas> test3(@PathVariable("id") String id) {
    
    
        RespData respData = new RespData();
        Clas clas = new Clas();
        List<Clas> list = new ArrayList<>();
        list.add(clas);
        clas.setChlid(list);
        respData.setData(new Stu());
        return respData;
    }
}

3.3 实体类定义

@Data
@ApiModel
public class Clas {
    
    

    @ApiModelProperty("编号")
    private String id;
    @ApiModelProperty("名称")
    private String name;
    @ApiModelProperty("子节点名称")
    private List chlid;
}

返回类

@Data
@ApiModel(value = "返回体")
public class RespData<T> {
    
    

    @ApiModelProperty("状态码")
    private String code;
    @ApiModelProperty("返回说明")
    private String msg;
    @ApiModelProperty("数据对象")
    private T  data;
}

4.启动运行

SpringBoot 启动成功后，访问 http://localhost:8080/doc.html

• 通用请求头Authorization配置
  
• 接口说明