swagger配置使用及自定义安全方案securitySchemes

最新推荐文章于 2024-05-22 08:02:37 发布

weixin_61607152

最新推荐文章于 2024-05-22 08:02:37 发布

阅读量1.1k

点赞数 9

文章标签：安全

本文链接：https://blog.csdn.net/weixin_61607152/article/details/135827678

版权

1.导入swagger依赖

这里使用的是springfox-boot-starter,同时导入knife4j插件（不导入也行，导入可以方便接口调试）。

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>
        
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>3.0.3</version>
        </dependency>

接下来编写swagger配置类

@Configuration
@EnableOpenApi
@EnableKnife4j
public class Knife4jConfig {

    @Bean
    public Docket defaultApi2() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                //分组名称
//                .groupName("2.X版本")
                .select()
                //这里指定Controller扫描包路径
                .apis(RequestHandlerSelectors.basePackage(""))
                .paths(PathSelectors.any())
                .build()
                .securitySchemes(securitySchemes())
                .securityContexts(securityContexts());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("项目名称")
                .version("1.0")
                .build();
    }

    private List<SecurityScheme> securitySchemes() {
        List<SecurityScheme> securitySchemeList = new ArrayList<>();
        securitySchemeList.add(new HttpAuthenticationScheme("Authorization",
                "JWT授权（数据将在请求头中进行传递)直接在下面框中输入token",
                "http",
                "Bearer",
                "JWT",
                new ArrayList<>()
        ));
        return securitySchemeList;
    }

    //过滤不需要进行验证的页面
    private List<SecurityContext> securityContexts() {
        List<SecurityContext> securityContexts = new ArrayList<>();
        securityContexts.add(
                SecurityContext.builder()
                        .securityReferences(defaultAuth())
                        //这些接口不用提供token即可访问。
                        .forPaths(PathSelectors.regex("^(?!/employee/login).*$"))
                        .forPaths(PathSelectors.regex("^(?!/identifyImageBase64).*$"))
                        .build());
        return securityContexts;
    }

    //全局的token配置
    private List<SecurityReference> defaultAuth() {
        List<SecurityReference> securityReferences = new ArrayList<>();
        securityReferences.add(new SecurityReference("Authorization", new AuthorizationScope[0]));
        return securityReferences;
    }
}