Swagger：首次枚舉值覆蓋類型

Question

我正在使用swagger doc爲我的應用程序生成API。 Doc是用yml編寫的，在某些地方它會定義一些枚舉的道具（我們使用mysql）。這看起來像：

properties: 
     type: 
     enum: 
      - "first" 
      - "second" 
      - "example" 
     type: "string" 
     title: 
     type: "string" 
    ... // And so on and on 

我期待得到的東西是這樣的：

{ 
    "type": "string", 
    "title": "string", 
} 

正如你所看到的，類型字段將是爲在配置文件中定義的字符串，但我我正在接受這一個：

{ 
    "type": "first", 
    "title": "string", 
} 

Swagger設置第一個值作爲數據類型，它絕對不正確。 所以問題是如何爲「類型」字段獲取值「字符串」。

Answer 1

我一直在用JSON寫我的swagger文檔。以下是我如何設置「枚舉」的示例。也許你可以把它翻譯成YML來獲得更好的想法。

"parameters":[ 
      { 
       "name":"userID", 
       "in":"path", 
       "description":"TO BE DETERMINED.", 
       "required":true, 
       "type":"string" 
      }, 
      { 
       "name":"embedded", 
       "in":"query", 
       "description":"TO BE DETERMINED", 
       "required":false, 
       "type":"array", 
       "items":{ 
       "enum":[ 
        "address", 
        "state" 
       ] 
       }, 
       "collectionFormat":"csv" 
      } 

如果你看看項目，你會發現我不使用類型，它工作正常。