基础配置类

    1. import springfox.documentation.service.SecurityScheme;
    2. import org.springframework.context.annotation.Bean;
    3. import springfox.documentation.builders.ApiInfoBuilder;
    4. import springfox.documentation.builders.PathSelectors;
    5. import springfox.documentation.builders.RequestHandlerSelectors;
    6. import springfox.documentation.service.*;
    7. import springfox.documentation.spi.DocumentationType;
    8. import springfox.documentation.spi.service.contexts.SecurityContext;
    9. import springfox.documentation.spring.web.plugins.Docket;
    11. import java.util.ArrayList;
    12. import java.util.Collections;
    13. import java.util.List;
    15. /**
    16.  * swagger配置
    17.  *
    18.  * @author mori
    19.  * @date 2021-07-28 09:38:00
    20.  */
    21. public class BaseSwaggerConfig {
    23.     private final String basePackage;
    24.     private final String title;
    25.     private final String description;
    26.     private final Contact contact;
    27.     private final String version;
    29.     public BaseSwaggerConfig(String basePackage, String title, String description, Contact contact, String version) {
    30.         this.basePackage = basePackage;
    31.         this.title = title;
    32.         this.description = description;
    33.         this.contact = contact;
    34.         this.version = version;
    35.     }
    37.     @Bean
    38.     public Docket createRestApi() {
    39.         return new Docket(DocumentationType.OAS_30)
    40.                 .apiInfo(apiInfo()).select()
    41.                 .apis(RequestHandlerSelectors.basePackage(basePackage)).paths(PathSelectors.any())
    42.                 .build()
    43.                 .securitySchemes(securitySchemes())
    44.                 .securityContexts(securityContexts());
    45.     }
    47.     private ApiInfo apiInfo() {
    48.         return new ApiInfoBuilder().title(title).description(description).contact(contact)
    49.                 .version(version).build();
    50.     }
    53.     private List<SecurityScheme> securitySchemes() {
    54.         return Collections.singletonList(HttpAuthenticationScheme.JWT_BEARER_BUILDER
    55.                 .name("Authorization")
    56.                 .scheme("bearer")
    57.                 .build());
    58.     }
    60.     private List<SecurityContext> securityContexts() {
    61.         List<SecurityContext> securityContexts = new ArrayList<>();
    62.         securityContexts.add(SecurityContext.builder()
    63.                 .securityReferences(defaultAuth())
    64.                 .build());
    65.         return securityContexts;
    66.     }
    68.     /**
    69.      * bearer 授权上下文
    70.      *
    71.      * @return List<SecurityContext>
    72.      */
    73.     private List<SecurityContext> securityContext() {
    74.         SecurityContext context = new SecurityContext(
    75.                 defaultAuth(),
    76.                 // 配置需要访问授权的请求，效果是对应页面上的请求有没有小锁图标
    77.                 PathSelectors.regex("/auth.*").negate(),
    78.                 // 配置需要访问授权的请求，效果是对应页面上的请求有没有小锁图标
    79.                 each -> true,
    80.                 // operationSelector优先级高于上面两个，配置需要访问授权的请求，效果是对应页面上的请求有没有小锁图标
    81.                 // 将auth开头的请求在swagger页面上放行，不使用jwt bearer token 授权方案
    82.                 operationContext -> !operationContext.requestMappingPattern().matches("/auth.*")
    83.         );
    84.         return Collections.singletonList(context);
    85.     }
    87.     /**
    88.      * bearer 授权范围
    89.      *
    90.      * @return List<SecurityReference>
    91.      */
    92.     private List<SecurityReference> defaultAuth() {
    93.         AuthorizationScope authorizationScope
    94.                 = new AuthorizationScope("global", "accessEverything");
    95.         AuthorizationScope[] authorizationScopes = {authorizationScope};
    96.         return Collections.singletonList(new SecurityReference("Authorization", authorizationScopes));
    97.     }
    99. }

    配置使用

    1.     @Configuration
    2.     @EnableOpenApi
    3.     private static class SwaggerConfig extends BaseSwaggerConfig {
    5.         private final static String BASE_PACKAGE = "com.xxx.api.controller";
    6.         private final static String TITLE = "API TITLE";
    7.         private final static String DESCRIPTION = "API DESCRIPTION";
    8.         private final static Contact CONTACT = new Contact("name", "url", "email");
    9.         private final static String VERSION = "v0.1";
    11.         public SwaggerConfig() {
    12.             super(BASE_PACKAGE, TITLE, DESCRIPTION, CONTACT, VERSION);
    13.         }
    14.     }