Swagger:在响应对象中使用特定值

Question

我正在使用 swagger 创建 API 文档，但找不到在响应中表示特定值的方法。

例如当API出现404错误时，响应是这样的:

{
    "code": 404,
    "result": "payment.notfound"
}

值永远是404，这怎么能用 Swagger 来表达呢。

谢谢!!

Answer 1

你可以这样:

/paths:
  /foo:
    /get:
      parameters: []
      responses:
        200:
          description: it worked
        404:
          description: "it didn't work"
          schema:
            type: object
            properties:
              code:
                type: integer
                format: int32
              result:
                type: string

如果你真的想说result只能是字符串payment.notfound，你可以简单地设置一个枚举:

result:
  type: string
  enum:
    - "payment.notfound"

这意味着，“它是一个字符串，但永远只能是这个值”。