授权 Header 未在 CURL springdoc-openapi-ui 中显示
Authorization Header not getting displayed in CURL springdoc-openapi-ui
我正在使用springdoc-openapi-ui
。我已经配置了名为 Authorization
的全局 header。
当我执行 API Authorization
时,请求的 CURL 中没有显示。我的其他参数显示在 CURL 中,除了 Authorization
.
以前,我使用的是 springfox-swagger-ui
,当时它显示在 CURL 部分。
我搜索了相同内容并在 https://swagger.io/docs/specification/describing-parameters/#header-parameters 上找到了注释
Note: Header parameters named Accept, Content-Type and Authorization are not allowed.
但我的要求是仅将 Authorization
用作 header。有什么方法可以实现吗?
下面加上我的SwaggerConfiguration
@Configuration
public class SwaggerConfiguration {
@Value("${title:title}")
private String title;
@Value("${description:description.}")
private String description;
@Value("${version:0.0.1}")
private String version;
@Value("${schemeId}")
String schemeIdentifier;
@Bean
public OperationCustomizer customGlobalHeaders() {
return (Operation operation, HandlerMethod handlerMethod) -> {
Parameter authorization = new Parameter().in(ParameterIn.HEADER.toString()).name("Authorization")
.description("Authorization details JWT token")
.schema(new StringSchema()).required(true);
Parameter applicationId = new Parameter().in(ParameterIn.HEADER.toString()).schema(new StringSchema())
.name("Application-Id").description("Originating application or client using the service")
.required(false);
operation.addParametersItem(authorization);
operation.addParametersItem(applicationId);
return operation;
};
}
@Bean
public GroupedOpenApi adminApi() {
String[] packagesToscan = { "abc.controller" };
return GroupedOpenApi.builder().setGroup("Client").packagesToScan(packagesToscan).build();
}
@Bean
public OpenAPI customOpenAPI() {
return new OpenAPI().info(new Info().title(title).version(version).description(description))
.components(new Components());
}
}
我已经搜索了相同的答案。
我们不能将授权设置为 header 和 springdoc open api
。如果我们想使用,那么我们需要在 swagger ui
.
上启用授权按钮
然后它将显示在 CURL 部分,如下所示。
在全球位置启用 swagger 授权按钮的代码
@Configuration
public class SwaggerConfiguration {
@Bean
public OpenAPI customOpenAPI() {
return new OpenAPI().info(new
Info().title("title").version("version").description("description"))
.addSecurityItem(new SecurityRequirement().addList("my security"))
.components(new Components().addSecuritySchemes("my security",
new SecurityScheme().name("my
security").type(SecurityScheme.Type.HTTP).scheme("bearer")));
}
}
我正在使用springdoc-openapi-ui
。我已经配置了名为 Authorization
的全局 header。
当我执行 API Authorization
时,请求的 CURL 中没有显示。我的其他参数显示在 CURL 中,除了 Authorization
.
以前,我使用的是 springfox-swagger-ui
,当时它显示在 CURL 部分。
我搜索了相同内容并在 https://swagger.io/docs/specification/describing-parameters/#header-parameters 上找到了注释
Note: Header parameters named Accept, Content-Type and Authorization are not allowed.
但我的要求是仅将 Authorization
用作 header。有什么方法可以实现吗?
下面加上我的SwaggerConfiguration
@Configuration
public class SwaggerConfiguration {
@Value("${title:title}")
private String title;
@Value("${description:description.}")
private String description;
@Value("${version:0.0.1}")
private String version;
@Value("${schemeId}")
String schemeIdentifier;
@Bean
public OperationCustomizer customGlobalHeaders() {
return (Operation operation, HandlerMethod handlerMethod) -> {
Parameter authorization = new Parameter().in(ParameterIn.HEADER.toString()).name("Authorization")
.description("Authorization details JWT token")
.schema(new StringSchema()).required(true);
Parameter applicationId = new Parameter().in(ParameterIn.HEADER.toString()).schema(new StringSchema())
.name("Application-Id").description("Originating application or client using the service")
.required(false);
operation.addParametersItem(authorization);
operation.addParametersItem(applicationId);
return operation;
};
}
@Bean
public GroupedOpenApi adminApi() {
String[] packagesToscan = { "abc.controller" };
return GroupedOpenApi.builder().setGroup("Client").packagesToScan(packagesToscan).build();
}
@Bean
public OpenAPI customOpenAPI() {
return new OpenAPI().info(new Info().title(title).version(version).description(description))
.components(new Components());
}
}
我已经搜索了相同的答案。
我们不能将授权设置为 header 和 springdoc open api
。如果我们想使用,那么我们需要在 swagger ui
.
然后它将显示在 CURL 部分,如下所示。
在全球位置启用 swagger 授权按钮的代码
@Configuration
public class SwaggerConfiguration {
@Bean
public OpenAPI customOpenAPI() {
return new OpenAPI().info(new
Info().title("title").version("version").description("description"))
.addSecurityItem(new SecurityRequirement().addList("my security"))
.components(new Components().addSecuritySchemes("my security",
new SecurityScheme().name("my
security").type(SecurityScheme.Type.HTTP).scheme("bearer")));
}
}