如何在springdoc-openapi-ui生成的swagger-ui中更改请求头中授权键的名称

Question

我的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("developer@batata.com");
    }

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

​

​

Answer 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。