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 不幸的是，我不知道如何在swagger express中做到这一点

Answer 1

我也很喜欢swagger-express，但有一点我建议，你必须使用type作为＆＃34; array＆＃34;在模型定义中：

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

希望这会对你有所帮助。

谢谢！

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

1 个答案: