swagger3 如何在文档里表示header里的token参数

在 Swagger3 中，可以使用 @Parameter 注解来描述请求头中的参数，包括 token 参数。

示例代码如下：

@Parameter(in = ParameterIn.HEADER, name = "Authorization", description = "Token", schema = @Schema(type = "string"))

其中，@Parameter 注解中的 in 属性表示参数位置，这里设置为 HEADER 表示请求头；name 属性表示参数名称，这里设置为 Authorization；description 属性表示参数描述，这里设置为 Token；schema 属性表示参数类型，这里设置为 string。

在使用该注解时，需要确保依赖的版本是 3.0.0 及以上，同时需要在启动类上添加 @EnableSwagger2WebMvc 注解。

相关问题

swagger3配置header

在Swagger3中配置header可以通过以下步骤实现：

1. 在SwaggerConfig类中添加如下代码：

@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.example.demo"))
            .paths(PathSelectors.any())
            .build()
            .apiInfo(apiInfo())
            .securitySchemes(Arrays.asList(apiKey()));
}

private ApiKey apiKey() {
    return new ApiKey("apiKey", "X-API-KEY", "header");
}

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("API Documentation")
            .description("API Documentation")
            .version("1.0.0")
            .build();
}

2. 在Controller中添加如下注解：

@ApiOperation(value = "API接口", notes = "API接口")
@ApiImplicitParams({
        @ApiImplicitParam(name = "X-API-KEY", value = "API Key", required = true, dataType = "string", paramType = "header")
})
@GetMapping("/api")
public String api() {
    return "Hello World!";
}

其中，@ApiImplicitParam注解用于描述请求参数，paramType属性设置为header即可。

swagger3添加token

可以在请求头中添加Authorization字段，并设置为Bearer {token}，其中{token}为获得的访问令牌。这样，在访问API时，就会将该token传递到后端，并进行验证。如何添加Authorization字段取决于你使用的客户端。可以参考Swagger官方文档来了解更多信息。