javascript - 在 swagger 文档中实现 void

Question

我无法弄清楚如何在仅返回响应代码的 Node 中实现 swagger(使用 swagger-node-express 项目)函数

例如对于这个 Swagger 的路径:

/api/user/create:
x-swagger-router-controller: api
get:
  operationId: userCreate
  parameters:
    - name: username
      in: query
      description: The username of the user.
      required: true
      type: string
    - name: password
      in: query
      description: The password of the user.
      required: true
      type: string
    - name: email
      in: query
      description: The email of the user.
      required: true
      type: string
  responses:
    '200':
      description: OK
    '412':
      description: User already exists

我想返回。

如果我尝试

res.json(200);

或

res.sendStatus(200);

甚至

res.sendStatus();

我收到错误:响应验证失败:void 不允许值

如果我发送，我会在 swagger 编辑器中收到一个解析错误

res.json()

我得到一个 void does not allow a value

我觉得我别无选择，所以我真的可以使用一些输入。

Answer 1

终于搞清楚错误是什么问题了:

Response validation failed: void does not allow a value

当你在 swagger.yaml 中有以下行时

responses:
  '200':
    description: OK

swagger 不明白应该发送什么样的响应。我们需要明确指定响应模式，如下所示，以说明有效的响应类型。

responses:
  200:
    description: Success
    schema:
      title: reset
      properties:
        message:
          type: string