openapi 3.0中所有API的强制标头
openapi 3.0中所有API的强制标头
提问于 2020-01-30 16:24:49
我使用的是带有Spring-boot5的YAML3.0，因此没有配置OpenAPI。我有一个包含客户端标识ID的标头(这不是身份验证标头)。我想让它成为一个强制的头参数。在OpenAPI配置下添加
@Configuration
public class OpenAPIConfiguration {
@Bean
public OpenAPI customOpenAPI() {
return new OpenAPI()
.components(new Components()
.addParameters("myCustomHeader", new Parameter().in("header").schema(new StringSchema()).required(true).description("myCustomHeader").name("myCustomHeader")))
.info(new Info()
.title("My Rest Application")
.version("1.2.26"));
}
}但是，swagger UI在任何API中都不显示所需的参数。有人能帮我指出我哪里做错了吗？
回答 1
Stack Overflow用户
回答已采纳
发布于 2020-01-30 19:31:11
将参数定义添加到自定义OpenAPI bean将不起作用，因为参数不会传播到操作定义。您可以使用OperationCustomizer实现您的目标
@Bean
public OperationCustomizer customize() {
return (operation, handlerMethod) -> operation.addParametersItem(
new Parameter()
.in("header")
.required(true)
.description("myCustomHeader")
.name("myCustomHeader"));
}OperationCustomizer接口是在springdoc-openapi 1.2.22中引入的。在以前的版本中，您需要使用OpenApiCustomiser
@Component
public class MyOpenApiCustomizer implements OpenApiCustomiser {
private static final List<Function<PathItem, Operation>> OPERATION_GETTERS = Arrays.asList(
PathItem::getGet, PathItem::getPost, PathItem::getDelete, PathItem::getHead,
PathItem::getOptions, PathItem::getPatch, PathItem::getPut);
private Stream<Operation> getOperations(PathItem pathItem) {
return OPERATION_GETTERS.stream()
.map(getter -> getter.apply(pathItem))
.filter(Objects::nonNull);
}
@Override
public void customise(OpenAPI openApi) {
openApi.getPaths().values().stream()
.flatMap(this::getOperations)
.forEach(this::customize);
}
private void customize(Operation operation) {
operation.addParametersItem(
new Parameter()
.in("header")
.required(true)
.description("myCustomHeader")
.name("myCustomHeader"));
}
}页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/59981687
复制相关文章
相似问题
腾讯云开发者
