recursion - 如何在 OpenAPI/Swagger 中递归引用封闭类型定义？

Question

我正在 Swagger 编辑器中编写 OpenAPI 定义。

我的一个类型定义包含一个数组，该数组包含与父元素类型相同的子元素。 IE。像这样:

definitions:
  TreeNode:
    type: object
    properties:
      name:
        type: string
        description: The name of the tree node.
      children:
        type: array
        items:
          $ref: '#/definitions/TreeNode'

但是，Swagger 编辑器不会在 children 中提取递归引用。数组，它简单地显示为“未定义”元素的数组。

有没有人知道如何做到这一点？`

Answer 1

你的定义完全没问题。这是在 Swagger Editor 和 Swagger UI 中呈现递归模式的一个已知问题:

https://github.com/swagger-api/swagger-ui/issues/3325

解决 null/undefined values 在“示例值”中，可以添加自定义 example到您的架构:

definitions:
  TreeNode:
    type: object
    properties:
      name:
        type: string
        description: The name of the tree node.
      children:
        type: array
        items:
          $ref: '#/definitions/TreeNode'
    example:
      name: foo
      children:
        - name: bar
        - name: baz
          children:
            - name: qux