如何将可能值列表添加到 swagger 文档中？

Question

假设我有以下路线：

paths:
  /data:
    get:
      summary: Get list of securities based on filter
      parameters:
        - name: market
          in: query
          description: Filter securities by market id, default ```all```
          type: string
          default: all

如何向其中添加可以使用的值列表？

这还支持吗？我看到一个 enum 字段，但在添加到任何参数时我总是收到错误。

Answer 1

enum 是要走的路。您可以在 enum 下为参数和属性指定值列表。下面是一个例子：

---
swagger: '2.0'
info:
  version: 0.0.0
  title: Simple API
paths:
  /data:
    get:
      summary: Get list of securities based on filter
      parameters:
        - name: market
          in: query
          description: Filter securities by market id, default ```all```
          type: string
          default: all
          enum:
          - all
          - market1
          - market2
      responses:
        200:
          description: OK

您可以将上面的内容复制并粘贴到 swagger-editor 以查看输出。

如何将可能值列表添加到 swagger 文档中？

How do I add a list of possible values to a swagger doc?

swagger

swagger-editor