我如何为具有相同基本路径但不同请求结构的2个API定义一个摇摇欲坠的规格



示例:

这是第一个定义:

/**
 * @swagger
 * /a/b/items:
 *   get:
 *     description: Get all the items
 *     responses:
 *      200:
 *          Returns an array of items
 */

这是第二个定义:

/**
 * @swagger
 * /a/b/items:
 *   get:
 *     description: Get items by ids
 *     parameters:
 *      - name: ids
 *        in: query
 *        required: true
 *        schema:
 *          $ref: '#/definitions/itemIds'
 *
 *     responses:
 *      200:
 *          description: Returns an array of items, given the itemIds
 */

很明显,这里的区别在于请求结构。请注意,对于第二个定义,我想通过查询中的参数ID。

第一个定义是一个简单的获取请求,而没有任何路径参数或查询参数。

第二个定义是具有相同基本路径但具有查询参数的Get请求。

当我连续定义这两个定义时,第二个定义写下了第一个定义,而Swagger UI仅显示第二个定义。

非常需要将这两个定义作为唯一的定义。

任何解决方案/思想/方法可以完成独特性?

更改API以支持文档只是" No Go"!

任何帮助将不胜感激。预先感谢!

我相信第二个定义中的端点需要更改为:

/a/b/items/{ids}:

最新更新