Как добавить заголовок с авторизацией для вызовов конечной точки springdo c -openapi

Question

Swagger2 (springfox) работал с:

@Bean
public Docket getDocket() {
    return new Docket(DocumentationType.SWAGGER_2)
        .select()
        .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
        .apis(RequestHandlerSelectors.any())
        .paths(PathSelectors.any())
        .build()
        .useDefaultResponseMessages(false)
        .globalOperationParameters(Collections.singletonList(getAuthHeader()));
}

private Parameter getAuthHeader() {
    return new ParameterBuilder()
        .parameterType("header")
        .name("Authorization")
        .modelRef(new ModelRef("string"))
        .defaultValue(getBase64EncodedCredentials())
        .build();
}

private String getBase64EncodedCredentials() {
    String auth = authUser.getUser() + ":" + authUser.getPassword();
    byte[] encodedAuth = Base64.encode(auth.getBytes(StandardCharsets.UTF_8));
    return "Basic " + new String(encodedAuth, Charset.defaultCharset());
}

Springdo c -openapi:

@Bean
public OpenAPI getOpenAPI() {
    return new OpenAPI().components(new Components()
        .addHeaders("Authorization", new Header().description("Auth header").schema(new StringSchema()._default(getBase64EncodedCredentials()))));
}

Я не могу достичь это для springdo c -openapi. Вроде не работает шапка.

Answer 1

Поведение, которое вы описываете, не связано с springdo c -openapi. Но для swagger-ui, который также уважает OpenAPI Spe c:

• https://github.com/swagger-api/swagger-ui/issues/5715

  Спецификация OpenAPI 3 не позволяет явно добавлять заголовок авторизации . Для получения дополнительной информации прочтите:

  Note: Header parameters named Accept, Content-Type and Authorization are not allowed. To describe these headers

  Прочтите:

• https://swagger.io/docs/specification/describing-parameters/#header -параметры .