如何將可能的值列表添加到swagger doc中？

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以查看輸出。