安全性没有从生成器添加到SwaggerOpen API

Question

我正在我的团队中进行一个新项目，我们正在按照API第一方法论实现一个API。我们正在使用openapi-Generator-maven-plugin从OpenAPI 3.0.3格式的yml文件生成我们的API。要生成swagger文件，我们使用springfox 2.9.2。我面临的问题是当我试图为请求的swagger添加安全性时。

components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
security:
  - bearerAuth: [ ]

“授权”按钮不会出现在“招摇过市”页面中，只会出现靠近请求的锁，但它不会执行任何操作（请参见下图）。

我观察到的是，如果我打开/v2/api-docs，swagger json不包括安全定义部分。

我设法添加安全性的唯一方法是在Docket对象中通过代码添加安全性部分，如下所示：

new Docket(DocumentationType.SWAGGER_2)
    .securityContexts(Collections.singletonList(securityContext()))
    .securitySchemes(Collections.singletonList(bearerJwtKey()))
    .select()
    .apis(RequestHandlerSelectors.basePackage("com.example"))
    .paths(PathSelectors.any())
    .build();

这是唯一一种为Swagger UI增加安全性的方法，还是我遗漏了什么？

Answer 1

原因：spring库中尚未实现承载身份验证：(

导入生成的配置类，然后将安全模式（ApiKey）添加到现有的Docket bean中。例子：

@Configuration
@Import(OpenAPIDocumentationConfig.class) // openapi generated config class
public class SwaggerConfiguration {
   @Autowired
   ApplicationContext context;

   @PostConstruct
   public void extendExistingDocketWithSecurity() {
      Docket docket = context.getBean(Docket.class);
      docker.securitySchemes(Collections.singletonList(bearer()));
   }

   private static ApiKey bearer() {
      // where "bearerAuth" - name of your schema in YML spec. file
      return new ApiKey ("bearerAuth", HttpHeaders.AUTHORIZATION, "header");
   }

完成！你真棒！现在您使用的是生成的招摇过市配置，而不是覆盖，而是扩展