Swagger中的多态性在鉴别器上产生奇怪的错误消息

Question

我正在编写一个服务，它的GET可以返回五种不同但密切相关的类型中的一种。因为用户希望能够一次搜索所有五种类型，所以只能进行一次get调用。我返回的是JSON，可以轻松处理任何类型。

我正试图在斯威格中这样做，使用他们的多态性特性，这是我以前从未尝试过的。我的做法与示例中的一样，只是在“定义”下，而不是在“组件/模式”下。但我收到了一条奇怪的错误信息，我无法理解。下面是swagger文件。错误是这样的：

定义['Event']处的架构错误。鉴别器应该是字符串

它在第49行给出了这个信息，上面写着< code>discriminator:

所以，我的两个问题是：我该如何解决它？这甚至会给我带来我需要的东西吗？

swagger: '2.0'
info:
  description: RESTful API to retrieve Titles Metadata
  version: 1.0.0
  title: Swagger Mystery

schemes:
- https
paths:
  /event:
    get:
      operationId: getEvent
      summary: searches names
      description: |
        Search by names, across all types, or by a specific type.
      produces:
      - application/json
      parameters:
      - in: query
        name: title
        description: name to search for
        required: true
        type: string
      - in: query
        name: start
        required: false
        type: boolean
      - in: query
        name: type
        required: false
        type: string
        description: |
          May be "contest", "partner", "sponsor", or "dancer". If missing, will search for all types.
      responses:
        '200':
          description: search results
# I also don't know why I need to comment these out.
          # content:
          #   application/json:
          #     schema:
          #       type: array
          #       items:
          #         $ref: '#/definitions/Event'
        '400':
          description: bad input parameter
definitions:
  Event:
    type: object
    discriminator:
      propertyName: eventType
    properties:
      eventType:
        type: string
      id:
        type: integer
        format: int64
      name:
        type: string
      description:
        type: string
      contests:
        type: array
        items: 
          $ref: '#/definitions/Contest'
    required:
    - id
    - name
    - description
    - contests
    - eventType
  Contest:
    allOf:
    - $ref: '#/definitions/Event'
    - type: object
      properties:
        parentEvent:
          type: string
        venue:
          type: string
      required:
      - parentEvent
      - venue
  Dancer:
    allOf:
    - $ref: '#/definitions/Event'
    - type: object
      properties:
        eventInvitationDate:
          type: string
          format: date
        venue:
          type: string
      required:
      - eventInvitationDate
      - venue
  # Sponsor:
  #   allOf:
  #   - $ref: '#/definitions/Event'
  #   - type: object
  #     properties:
  #       invitationDate:
  #         type: string
  #         format: date
  #       parentEvent:
  #         type: string
  #       partners:
  #         type: array
  #         items:
  #           $ref: '#/definitions/Partner'
  Partner:
    allOf:
    - $ref: '#/definitions/Event'
    - type: object
      properties:
        invitationDate:
          type: string
          format: date
        parentEvent:
          type: string
        venue:
          type: string
      required:
      - invitationDate
      - parentEvent
      - venue
# two problems:
# 1. Schema error at definitions['Event'].discriminator
#    should be string on line 49 (discriminator:)
# 2. Resolver error:
#    e is undefined
#    (no line number)
#    (This error goes away when I comment out Sponsor.)

Answer 1

discriminator:
  propertyName: eventType

在 OpenAPI 2.0 中，鉴别器的值是属性名称：

discriminator: eventType

此外，OpenAPI 2.0假设鉴别器属性(在本例中为< code>eventType)的可能值与< code>definitions中的模型名称完全相同。那就是:

查看问题，了解 OpenAPI 2.0 中鉴别器用法的更多示例：

• 摇摆不定的继承和组成
• 多态性中的“鉴别器”，OpenAPI 2.0（Swagger 2.0）
• 摇摆：取决于字段值的变体架构形状