node.js - 在带有 openapi 3.0 的 Swagger 中，没有显示我的嵌套对象方案

Question

我在一个带有 express 框架的 nodeJS 项目中工作，我正在使用 swagger-jsdoc 和 swagger-ui-express，我也在 yaml 文件中编写我的配置。我想记录我的服务，但是当我尝试显示嵌套对象时遇到了一些问题。简单地说，当我展开嵌套对象树时，我什么也看不到。请帮忙。

[Swagger definition][1]
[My yaml file][2]
[Result in browser][3]

[1]: https://i.stack.imgur.com/by9EU.png
[2]: https://i.stack.imgur.com/KMyXN.png
[3]: https://i.stack.imgur.com/OHwlt.png

Answer 1

其值为另一个对象的实例的属性定义如下：

components:
  schemas:
    ...
    BuilderElementRequest:
      type: object
      properties:

        pageSectionElementRequest:
          $ref: '#/components/schemas/PageSectionElementRequest'   # <---------

        removedElements:
          type: array
          items:
            type: string

要为 OpenAPI 3.0.x 中的引用模式添加自定义示例（即覆盖默认示例），您需要将 into 包装$ref起来allOf：

        pageSectionElementRequest:
          allOf:
            - $ref: '#/components/schemas/PageSectionElementRequest'
          example:
            element: '11112'