如何将可能的值列表添加到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以查看输出。