spring boot springfox(swagger) 添加 header 请求参数

spring boot springfox(swagger) 添加 header 请求参数

全局配置 header 请求参数

设置 globalRequestParameters 参数信息

.globalRequestParameters(
                        Collections.singletonList(new RequestParameterBuilder()
                                .name("access_token")
                                .description(" token 信息 ")
                                .in(ParameterType.HEADER)
                                .required(true)
                                .build()));

原配置类

/**
 * @author 陈明勇
 */
@Configuration
@EnableSwagger2
public class Swagger2Config {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.OAS_30)
                .select()
                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .build()
                .apiInfo(apiInfo())
                .globalRequestParameters(
                        Collections.singletonList(new RequestParameterBuilder()
                                .name("access_token")
                                .description(" token 信息 ")
                                .in(ParameterType.HEADER)
                                .required(true)
                                .build()));
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("swagger 文档标题")
                .description("swagger 文档描述")
                .version("1.0 swagger 文档版本")
                .build();
    }
}

效果展示

更多用法可到本人博客 swagger 专栏或者官网查看 http://springfox.github.io/springfox/docs/current/