如何给swagger加请求头的三种方法 @ApiImplicitParam @Header 单方法和全局

Java充电桩

已于 2022-04-06 14:04:36 修改

阅读量6.5k

点赞数 1

分类专栏： swagger 开发模板文章标签： spring boot

于 2022-04-02 13:09:56 首次发布

本文链接：https://blog.csdn.net/weixin_45369440/article/details/123917676

版权

开发模板同时被 2 个专栏收录

6 篇文章

订阅专栏

swagger

4 篇文章

订阅专栏

本文介绍了如何在Spring Boot项目中使用Swagger进行API文档生成时，如何手动配置请求头。通过@ApiImplicitParam和全局配置Docket，展示了如何添加Authorization等头部参数，并在控制器方法和全局设置中进行区分。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

场景是这样的,我们自己封装了一个工具类去获取请求头里的东西, 但是在swagger没有自动给一个请求头,所以就得另外配, 不是配在@ApiOperation中.

单方法添加请求头

@ApiImplicitParam

swagger提供的注解, 手动配置,就在controller某个接口方法上,类似@ApiOperation的位置,上下都可以

@GetMapping("page")
@ApiOperation(value = "分页搜索")
@ApiImplicitParam(name = "Authorization", value = "Authorization",required = true, dataType = "String",paramType="header")
public Result getPage(long current) {
	return null;
}

@RequestHeader

spring提供的注解,类似@RequestParam, 加在请求参数中, 也是可以直接帮你套进来,这个参数还可以拿来用

@GetMapping("page")
@ApiOperation(value = "分页搜索")
public Result getPage(@RequestParam("current") long current,@RequestHeader("userId") long userId) {
	return service.getPage(current,userId);
}

全局配置

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

    @Value("${swagger-host}")
 	private String swaggerHost;

    @Bean
    public Docket createRestApi() {
        ParameterBuilder aParameterBuilder = new ParameterBuilder();
        aParameterBuilder.name("Authorization").description("Authorization").modelRef(new ModelRef("string")).parameterType("header").build();

        List<Parameter> aParameters = Lists.newArrayList();
        aParameters.add(aParameterBuilder.build());
        return new Docket(DocumentationType.SWAGGER_2)
        		.host(swaggerHost)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.linnine.demo.controller"))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo())
                .globalOperationParameters(aParameters);
    }
}