如何从招摇定义中排除属性

Posted 2023-02-19

【中文标题】如何从招摇定义中排除属性

【英文标题】：How to exclude property from swagger definition

【发布时间】：2017-08-16 01:13:31

【问题描述】：

我正在使用 Swagger 在线编辑器。我在定义中创建了一些模型

  Object:
    type: object
    properties:
      id:
        type: integer
        format: int32
      name:
        type: string
      some_variable_to_exclude:
        type: string

这是完整的模型，我在不同的响应中使用它。但是在其中一个中，我希望我的模型不存在属性“some_variable_to_exclude”。我怎样才能排除它？有可能吗？ 好的，也许不排除，也许在属性附近有一些评论，但仅限于该回复。

【参考方案1】：

为了使用自定义对象扩展 Swagger Schema，该字段必须以 x- 开头

在此处查看更多信息：http://swagger.io/specification/#vendorExtensions

例如，swagger-node 使用x-swagger-router-controller 来指定用于特定 API 路径的控制器。但是你可以将它用于任何你需要的东西，例如，x-custom-property

【参考方案2】：

创建另一个没有您不需要的字段的定义