Spring Boot Swagger2的使用

导入swagger

// swagger文档相关库
    implementation io.springfox:springfox-swagger2:2.9.2
    implementation io.springfox:springfox-swagger-ui:2.9.2
    implementation "com.github.xiaoymin:swagger-bootstrap-ui:1.9.6"
    implementation com.github.xiaoymin:knife4j-spring-boot-starter:2.0.4

SwaggerConfig.java

@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI
@Profile({
          
   "dev", "test"})
public class SwaggerConfig {
          
   

    @Bean
    public Docket createRestApi() {
          
   
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // 加了ApiOperation注解的类,才会生成接口文档
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                // 指定包下的类,才生成接口文档
                .apis(RequestHandlerSelectors.basePackage("com.example"))
                .paths(PathSelectors.any())
                .build()
//                .securitySchemes(security())
                .securityContexts(securityContexts());
    }

    private ApiInfo apiInfo() {
          
   
        return new ApiInfoBuilder()
                .title("接口文档")
                .description("接口文档")
                .termsOfServiceUrl("https://www.52itit.com/")
                .version("1.0.0")
                .build();
    }

    private List<ApiKey> security() {
          
   
        return Lists.newArrayList(
                new ApiKey("token", "token", "header")
        );
    }

    private List<SecurityContext> securityContexts() {
          
   
        return Lists.newArrayList(
                SecurityContext.builder().securityReferences(defaultAuth())
                        //过滤要验证的路径
                        .forPaths(PathSelectors.regex("^(?!auth).*$"))
                        .build()
        );
    }

    //增加全局认证
    List<SecurityReference> defaultAuth() {
          
   
        AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
        AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
        authorizationScopes[0] = authorizationScope;
        List<SecurityReference> securityReferences = new ArrayList<>();
        // 由于 securitySchemes() 方法中 header 写入值为 token,所以此处为 token
        securityReferences.add(new SecurityReference("token", authorizationScopes));
        return securityReferences;
    }
}

查看Json文档路径

域名+/v2/api-docs
经验分享 程序员 微信小程序 职场和发展