Swagger 文件（YAML）中的重载描述 [重复]

Question

我在编写 swagger 文件时遇到问题。当我描述一个参数时，该描述会被同一参数的 $ref 描述重载（参见下面的示例）。

a-body:
    description: The body
    type: object
    properties:
      my_param:
        description: Full description 
        $ref: '#/definitions/reference'

definitions:
    reference:
        type: object
        required: [req]
        description: an http reference
        properties:
          req:
            type: string

结果： the description is overloaded

有人可以帮我解决这个问题吗？

Answer 1

$ref 覆盖其所有同级属性 - 这就是 $ref 的工作方式。您可以尝试使用以下方法解决此问题：

my_param:
  description: Full description 
  allOf:
    - $ref: '#/definitions/reference'

这将在 Swagger 编辑器和 Swagger UI 中工作。

OpenAPI 规范存储库中还有一个feature request，以提供将$ref 与其他属性结合起来的更好方法。