swagger 全局 token配置 + 单个接口token配置

最新推荐文章于 2024-04-11 05:48:46 发布

wew666

最新推荐文章于 2024-04-11 05:48:46 发布

阅读量993

点赞数 1

分类专栏：工具 swagger 文章标签： java

本文链接：https://blog.csdn.net/weixin_50420750/article/details/127752780

版权

工具同时被 2 个专栏收录

3 篇文章 0 订阅

订阅专栏

swagger

1 篇文章 0 订阅

订阅专栏

全局token配置

这里是完整代码

@Bean
    @SuppressWarnings("all")
    public Docket createRestApi() {
        ParameterBuilder ticketPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<>();
        ticketPar.name("Authorization").description("token")
                .modelRef(new ModelRef("string"))
                .parameterType("header")
                .defaultValue("Bearer ")
                .required(false)
                .build();
        pars.add(ticketPar.build());
        return new Docket(DocumentationType.SWAGGER_2)
                .directModelSubstitute(LocalDateTime.class, String.class)
                .directModelSubstitute(Date.class, String.class)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.fxp"))
                .paths(PathSelectors.any())
                .build()
                .securitySchemes(securitySchemes())
                .securityContexts(securityContexts());
    }

    private List<SecurityScheme> securitySchemes() {
        List<SecurityScheme> apiKeyList = new ArrayList<>();
        apiKeyList.add(new ApiKey("token", "token", "header"));
        return apiKeyList;
    }

    private List<SecurityContext> securityContexts() {
        List<SecurityContext> securityContexts = new ArrayList<>();
        securityContexts.add(
                SecurityContext.builder()
                        .securityReferences(defaultAuth())
                        .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("token", authorizationScopes));
        return securityReferences;
    }


//    @Bean
//    public Docket createRestApi() {
//        return new Docket(DocumentationType.SWAGGER_2)
//                .apiInfo(apiInfo())
//                .select()
//                .apis(RequestHandlerSelectors.basePackage("com.fxp"))
//                .paths(PathSelectors.any())
//                .build()
//                .securitySchemes(security());
//    }

    public ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Quartz定时任务")
                .description("测试swagger配置定时任务")
                .version("1.5")
                .build();
    }

    /**
     * 接口同意 token
     * @return
     */
    private List<SecurityScheme> security() {
        List<SecurityScheme> list = new ArrayList<>();
        list.add(new ApiKey("token", "token", "header"));
        return list;
    }

注意！！！！！
这里是加上全局配置
在这里插入图片描述
这个值是后面取值的key

单个接口token配置

@ApiImplicitParams({
            @ApiImplicitParam(paramType = "header", name = "token", required = true),
    })
    @ApiOperation("查询")
    @PostMapping("select")
    public Result select(@RequestBody CharacterSelectVo vo){
        return iCharacterService.select(vo);
    }
在接口上添加
@ApiImplicitParams({
            @ApiImplicitParam(paramType = "header", name = "token", required = true),
    })
    这个注解