Как изменить имя ключа авторизации в заголовке запроса в swagger-ui, сгенерированном springdoc-openapi-ui

Моя конфигурация OpenAPI

Мне нужно изменить ключ заголовка с авторизации на внутреннюю авторизацию

    @Bean
    public OpenAPI customOpenAPI(OpenApiConfig config) {
        return new OpenAPI().addSecurityItem(new SecurityRequirement().addList("security-schemes"))
            .components(new Components().addSecuritySchemes("security-schemes", securitySchema()))
            .info(new Info().title(config.getTitle()).contact(contact())
            .version(config.getAppVersion())
            .description(config.getDescription())
            .termsOfService("https://www.batata.com.br/site/")
            .license(new License().name("Banco - Batata 1.0").url("https://www.batata.com.br/site/")));
    }

    private Contact contact() {
        return new Contact().name("Banco Batata").url("https://www.batata.com.br/site/").email("[email protected]");
    }

    @Bean
    private SecurityScheme securitySchema() {
        return new SecurityScheme().type(SecurityScheme.Type.HTTP).scheme("bearer").bearerFormat("JWT")
                .in(SecurityScheme.In.HEADER).name("Authorization-internal");
    }

Созданное изображение


person Gleidosn    schedule 21.07.2020    source источник


Ответы (1)


Спецификация 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-parameters.

person Community    schedule 13.08.2020