欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

springboot配置swagger2 header头部添加token参数

程序员文章站 2022-07-02 14:50:37
...

项目里有拦截器,这个拦截器要截取token进行校验,swagger测试发现没办法输入token值,然后就想能不能配置一下就让swagger测试的时候也能输入token,下面的配置就可以实现这样的操作。

@Configuration
public class SwaggerConfig {
    // swagger2的配置文件,这里可以配置swagger2的一些基本的内容,比如扫描的包等等
    @Bean
    public Docket createRestApi() {
        // 添加token参数
        ParameterBuilder aParameterBuilder = new ParameterBuilder();
        aParameterBuilder
                .parameterType("header")
                .name("token")
                .description("token值")
                .modelRef(new ModelRef("string"))
                .required(false).build();
        List<Parameter> aParameters = new ArrayList<Parameter>();
        aParameters.add(aParameterBuilder.build());
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // 为当前包路径
                .apis(RequestHandlerSelectors.basePackage("com.xiyin.finance"))
                .paths(PathSelectors.any())
                // 全局配置
                .build().globalOperationParameters(aParameters);
    }

    // 构建 api文档的详细信息函数,注意这里的注解引用的是哪个
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 页面标题
                .title("java")
                // 创建人信息
                .contact("df")
                // 版本号
                .version("1.0")
                // 描述
                .description("java调用接口说明")
                .build();
    }
}

springboot配置swagger2 header头部添加token参数 

拦截器里获取头部token获取成功

springboot配置swagger2 header头部添加token参数

 

相关标签: 编程工具