如何使用Swagger express在我的Swagger UI中添加數組和示例？

Question

總而言之，我基本上是在嘗試根據這個“教程”制作一個招搖的Ui： https ： //github.com/fliptoo/swagger-express

不幸的是，它根本沒有描述如何為正文添加示例以及如何添加數組。

我現在的文檔代碼是：

/**
* @swagger
* path: /animal/dogs
* operations: 
*   -  httpMethod: POST
*      summary: Add several dogs to the animal shelter
*      notes: Returns results of the post
*      responseClass: Shelter
*      nickname : shelterPostWithDogs
*      consumes: 
*        - application/json
*      parameters:
*        - name: body
*          schema: true
*          description: Dogs object that needs to be added
*          paramType: body
*          required: true
*          dataType: Dog
*/

而我在底部：

/**
* @swagger
* models:
*  Dog:
*      id: Dog
*      properties:
*          dog_id:
*              required: true
*              type: int
*  Shelter:
*      id: Shelter
*      properties:
*          shelter_id:
*              type: int
*          location:
*              type: string                             
*/

不幸的是，有了這個，我在我的模型中有這個：

Dog {
    dog_id (int)
}

我想改為：

Dog {
    [
        { dog_id(int)}
    ]
}

我需要更改才能獲得此結果？

額外獎勵：如何在模型中添加示例？ 我想要類似這樣的東西： http ： //petstore.swagger.io/#!/pet/addPet不幸的是，我不知道如何在招搖快遞中做到這一點

Answer 1

我也很喜歡swagger-express，但有一點我建議，你必須在模型定義中使用type作為“數組”：

Dog:
   id: Dog
      properties:
          dog_id:
              required: true
              type: **array**

希望這會幫助你。

謝謝！