javascript – 在swagger文档中实现void

2023年2月22日 249次阅读

我无法弄清楚如何在节点中实现一个swagger(使用swagger-node-express项目)函数,该函数只返回响应代码

例如,对于这个昂首阔步的道路：

/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()

我得到一个虚空不允许值

我觉得我没有选择尝试,所以我真的可以使用一些输入.

最佳答案 最后想出了错误的问题：

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
点赞