2017-10-05 202 views
4

我使用揚鞭OpenAPI的規格工具,我有一個字符串數組屬性中的定義之一如下:如何在swagger propertise中添加多個示例值?

cities: 
     type: array 
     items: 
      type: string 
      example: "Pune" 

我的API產生JSON結果因此對於下面的結果上述對象出現在響應:

{ 
    "cities": [ 
    "Pune" 
    ] 
} 

試過逗號分隔的字符串象下面這樣:

cities: 
      type: array 
      items: 
       type: string 
       example: "Pune", "Mumbai", "Bangaluru" 

期待結果爲:

{ 
     "cities": [ 
     "Pune", 
     "Mumbai", 
     "Bangaluru" 
     ] 
    } 

但編輯器顯示錯誤。 「Bad indentation」

我想給示例標籤提供多個值有沒有什麼辦法?

更新

用戶海倫下面給了正確的答案我有indentaion問題,因此有嵌套的數組(二維數組)

正確方法:

cities: 
     type: array 
     items: 
      type: string 
     example: 
     - Pune 
     - Mumbai 

我的方式(這是錯)

cities: 
     type: array 
     items: 
      type: string 
      example: 
      - Pune 
      - Mumbai 

在上述兩種情況下尋找example標籤的縮進,使其不同,它的YAML縮進很重要。

回答

2

要顯示與多個項目的陣列例如,在陣列級,而不是項目級別添加example

cities: 
    type: array 
    items: 
    type: string 
    example: 
    - Pune 
    - Mumbai 
    - Bangaluru 

    # or 
    # example: [Pune, Mumbai, Bangaluru] 
+0

你給輸出「城市」的解決方案:[ [ 「普納」, 「孟買」 ] ]這是兩個嵌套數組,我不希望我想要單個數組將數組元素作爲數組元素保存而不是新數組,感謝您的回覆 – pcj

+0

你在哪裏看到嵌套數組?它在Swagger編輯器中工作正常: https://i.stack.imgur.com/uT85I.png – Helen

+0

嘿謝謝海倫縮進問題看到更新的問題。 – pcj

相關問題