Swagger header 定义

Question

我似乎无法找到是否可以声明一个 header 对象以便在响应 header 中重用它，有一些示例定义了响应模式的对象，但它不会转置为响应 header 。我只设法制作了一个可重用的响应对象，如下所示:

responses:
  DownloadOk:
    description: Dowload Ok
    headers:
      Content-Length:
        description: response length
        type: integer 
      Document-Length:
        description: document length
        type: integer 

但正如我所说，我只想保留标题部分。

这是我想使用它的地方:

responses:
    200:
      description: Dowload Ok
      headers:
        $ref: '#/definitions/DowloadOk'

Answer 1

根据 Swagger/OpenAPI 规范，你不能。 Definitions必须包含 Schema Objects ，那些不允许任意属性，而是 JSON 模式的特定子集(参见 the link)。

您可以定义 Response Object并引用，因为Swagger Object拥有全局responses属性(property)。标题没有这样的事情。反正不是这个时候。请求这样的功能可能是值得的。