大摇大摆的对象的架构

Question

我正在为两个获取路径编写一个模式，其中结果是一个类似的对象

{
  "id":"49077acb6ac8",
  "info":
    {
      "name":"test"
    }
}

其实我得到了这个：

/*
* @swagger
*  definitions:
*    getVCenter:
*      id:
*        type: string
*        format: uuid
*      info:
*        type: object
*      properties:
*        name:
*          type: string
*        fullName:
*          type: string
*        vendor:
*          type: string
* /v1/vcenters/:
*   get:
*     tags:
*       - vcenters
*     summary: Get availables vCenters.
*     description: Get a list of availables vCenters.
*     produces:
*       - application/json
*     responses:
*       200:
*         description: an array of vCenters
*         schema:
*           $ref : '#definitions/getVCenter'
*/

但它不再起作用了。

谁能解释一下我做错了什么？

Answer 1

您的注释中有语法错误。

info 属性的缩进应该如下：

*      info:
*        type: object
*        properties:  # <-- "properties" must be on the same level as "type: object"
*          name:
*            type: string
*          fullName:
*            type: string
*          vendor:
*            type: string

在$refs 中，# 之后必须有一个/ - 将#definitions 替换为#/definitions：

$ref : '#/definitions/getVCenter'

另外，如果响应应该是“一个 vCenter 数组”而不是单个 vCenter，那么响应架构应该是：

*     responses:
*       200:
*         description: an array of vCenters
*         schema:
*           type: array
*           items:
*             $ref : '#/definitions/getVCenter'