Swagger3整合

一 、Swagger3

1. 开关

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

// 主启动类
@EnableOpenApi

2. 访问

# 代码中不需要再进行任何其他形式的入侵
# swagger页面
http://localhost:8081/swagger-ui/index.html

3. 自定义界面

• swagger3的配置类要和主配置类Application.java放在同一个目录下

package com.smart.coach;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

// http://localhost:8082/swagger-ui/index.html

@Configuration
@EnableOpenApi // 主配置类上可以不加
public class Swagger3 {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
            .apiInfo(apiInfo()
            );
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
            .title("smart-coach")
            .version("1.0-SNAPSHOT")
            .build();
    }
}

4. Swagger3整合JWT

4.1. Swagger3

package com.smart.coach;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.ApiKey;
import springfox.documentation.service.AuthorizationScope;
import springfox.documentation.service.SecurityReference;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;

import java.util.Arrays;
import java.util.List;

import static com.smart.coach.constant.ApplicationConfig.ACCESS_TOKEN;

@Configuration
@EnableOpenApi
public class Swagger3 {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.OAS_30)
            .apiInfo(apiInfo())
            .securityContexts(Arrays.asList(securityContext()))
            .securitySchemes(Arrays.asList(apiKey()))
            .select()
            .apis(RequestHandlerSelectors.any())
            .paths(PathSelectors.any())
            .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
            .title("smart-coach")
            .version("1.0-SNAPSHOT")
            .build();
    }

    private ApiKey apiKey() {
        return new ApiKey(ACCESS_TOKEN, "access_token", "header");
    }

    private SecurityContext securityContext() {
        return SecurityContext.builder().securityReferences(defaultAuth()).build();
    }

    private List<SecurityReference> defaultAuth() {
        AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
        AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
        authorizationScopes[0] = authorizationScope;
        return List.of(new SecurityReference(ACCESS_TOKEN, authorizationScopes));
    }
}

4.2 页面

• 在这里赋值后，后面所有的接口访问时候，都会带access_token 的 header
• 每个接口里面，进行页面访问拦截，验证token是否过期

二、Lombok插件

• springboot现在已经开始管理lombok的依赖了，所以pom中不需要定义lombok的版本
• import lombok.extern.slf4j.Slf4j， 管理日志

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>