如何在生成Spring代码时使用OpenAPI“oneOf”属性与openapi-Generer-maven-plugin

Question

我正在开发一个具有Angular前端和RESTful Spring Boot Backend的应用程序

我从org.openapitools.找到了这个非常方便的maven插件openapi生成器maven插件凭借其代码生成功能，它有助于在我们的应用编程接口的前端和后端之间实施“合同优先”的方法。但是我们的swagger文件在请求体和响应体定义中使用了“oneOf”属性。我试图从中生成Spring代码，但是生成的Java类缺少导入：

import com.pack.api.dto.OneOfLatteCoffeAmericanoCoffe;
import com.pack.api.dto.UNKNOWN_BASE_TYPE;

有没有办法将插件配置为与Swagger的oneOf属性一起工作？我用的是Spring靴2.3。1、Swagger 3.0和Openapi生成器maven插件4.3

Answer 1

我们已经为一些生成器添加了更好的oneOf和anyOf支持，如java（jersey2）、cshing-netcore等。请用最新的大师试一试。快照版本可以在项目的README：https://github.com/OpenAPITools/openapi-generator/中找到

Answer 2

如果您可以修改您的招摇过市，您可以将中的一个替换为对抽象类型的引用。

例如，如果您的昂首阔步看起来像这样：

components:
  schemas:
    'Parent':
      'vehicle':
        oneOf:
        - type: object
          properties:
            'car_property':
              type: string
        - type: object
          properties:
            'truck_property':
              type: string

您可以这样修改它：

components:
  schemas:
    'Parent':
      'vehicle':
        $ref: '#/components/schemas/Vehicle'
    #---------------------------------------------------------------------------
    # Abstract class with discriminator 'vehicle_type'
    #---------------------------------------------------------------------------
    'Vehicle':
      type: object
      properties:
        'vehicle_type':
          type: string
          enum: [ 'CAR', 'TRUCK' ]
      discriminator:
        propertyName: vehicle_type
        mapping:
          'CAR': '#/components/schemas/Car'
          'TRUCK': '#/components/schemas/Truck'
    #---------------------------------------------------------------------------
    # Concrete classes
    #---------------------------------------------------------------------------
    'Car':
      allOf:
      - $ref: "#/components/schemas/Vehicle"
      - type: object
        properties:
          'car_property':
            type: string
    'Truck':
      allOf:
      - $ref: "#/components/schemas/Vehicle"
      - type: object
        properties:
          'truck_property':
            type: string

这种矫揉造作的修改使发电机工作。它处理相同的JSON对象，尽管我不能100%确定它在OpenAPI规范中是否语义等价。

Answer 3

目前，openapi生成器不支持oneOf。这是OpenAPI v3新引入的功能（仅供参考，只有v2及以下被称为“斯瓦格”，然后它被重命名为OpenAPI）。有各种各样的生成器（Java，Spring，许多其他语言）。我已经看到，在这一年中已经做出了贡献，以启用oneOf支持。

总而言之，看起来您还需要再等一会儿，直到您可以使用Spring生成器利用OpenAPI v3规范的此功能。

编辑：它也列在“短期路线图”上：

OAS3。0功能支持：anyOf、oneOf、回调等