Question

我定义了这个架构：

User:
  type: object
  required:
    - id
    - username
  properties:
    id:
      type: integer
      format: int32
      readOnly: true
      xml:
        attribute: true
      description: The user ID
    username:
      type: string
      readOnly: true
      description: The username
    first_name:
      type: string
      description: Users First Name
    last_name:
      type: string
      description: Users Last Name
    avatar:
      $ref: '#/components/schemas/Image'
  example:
    id: 10
    username: jsmith
    first_name: Jessica
    last_name: Smith
    avatar: image goes here
  xml:
    name: user

效果很好。 GET /user/{id}调用显示示例数据就好了。

我有第二个模式，它创建了上述模式的数组：

ArrayOfUsers:
  type: array
  items:
    type: object
    required:
      - id
      - username
    properties:
      id:
        type: integer
        format: int32
        xml:
          attribute: true
        description: The user ID
      username:
        type: string
        description: The username
      first_name:
        type: string
        description: Users First Name
      last_name:
        type: string
        description: Users Last Name
      avatar:
        $ref: '#/components/schemas/Image'

这也很有效。 GET /user调用在数组中显示正确的结构。

但我不想两次定义此架构。

我想创建一个使用第一个并坚持在数组中的模式。

我在这次尝试中失败了。

我试过这种方式：

UserArray:
  type: array
  items:
    type: object
    required:
      - id
      - username
  properties:
    things:
      type: array
      items:
        oneOf:
          - $ref: '#/components/schemas/User'

这次尝试给了我一个空数组：

[
  {}
]

这不是我想要的结果。

有关此的任何提示吗？

Answer 1

User个对象的数组定义如下：

UserArray:
  type: array
  items:
    $ref: '#/components/schemas/User'

如何在OpenAPI 3中定义另一个模式的数组？

1 个答案: