Swagger 3.0 - 无法向查询参数添加参数

Question

我有 Node Express 应用程序并且正在使用

swagger-jsdoc & swagger-ui-express

在路由器内部我放置此代码：

/**
 * @swagger
 * /get:
 *  get:
 *      tags: [ /api/roba/get ]
 *      summary: Vraca informacije o robi po datom id-u
 *      description: Vraca informacije o robi po datom id-u
 *      parameters:
 *          - name: robaid
 *      responses:
 *          400:
 *              description: Nije prosledjen parametar robaid
 */

它确实可以正常工作，但是当我尝试添加

description

或

- name

下的其他任何内容时，它不会显示该端点。

我收到错误

YAMLSemanticError：隐式映射键需要位于第 7 行第 18 列的单行上：-名称：robaid

不起作用的代码（我只尝试了必需的或描述，认为其中之一不起作用但不起作用）：

/**
 * @swagger
 * /get:
 *  get:
 *      tags: [ /api/roba/get ]
 *      summary: Vraca informacije o robi po datom id-u
 *      description: Vraca informacije o robi po datom id-u
 *      parameters:
 *          - name: robaid
 *          required: true
 *          description: Some description
 *      responses:
 *          400:
 *              description: Nije prosledjen parameter robaid
 */

Answer 1

您看到问题是因为

required

和

description

行上的缩进不正确，您可以尝试以下代码：

/**
 * @swagger
 * /get:
 *  get:
 *      tags: [ /api/roba/get ]
 *      summary: Vraca informacije o robi po datom id-u
 *      description: Vraca informacije o robi po datom id-u
 *      parameters:
 *          - name: robaid
 *            required: true
 *            description: Some description
 *      responses:
 *          400:
 *              description: Nije prosledjen parameter robaid
 */

希望有帮助！