Question

我正在尝试从NodeJS swagger.json中的请求URL传递查询参数。但我没有定义。

这是URL reset/password?email=myname@mail.com

在NodeJS上招摇＆＃34;参数＆＃34;：[ { ＆＃34; name＆＃34;：＆＃34;参数＆＃34;，＆＃34;在＆＃34;：＆＃34;＆＃34;，
＆＃34;必需＆＃34;：是的，＆＃34;输入＆＃34;：＆＃34; string＆＃34;，＆＃34;架构＆＃34;：{ ＆＃34; $ ref＆＃34;：＆＃34;＃/ definitions / resetPassword＆＃34;， } } ]，

Answer 1

更改此代码："in": "query"

Answer 2

通过JSON传递查询参数的示例：

网址：reset/password?email=myname@mail.com

parameters:
        - in: path
          name: email
          type: string
          required: true
          description: description of parameter

Answer 3

您的参数定义应如下所示：

"parameters": [
    {
      "name": "email",
      "in": "query",
      "type": "string",
      "format": "email",
      "required": true
    }
  ]

in: query表示该参数在查询字符串中传递。

name: ...是参数名称（在您的示例中为email）。

type: string和format: email表示参数类型。查询参数需要原始type（字符串，数字等）或数组类型，但它们不能$ref定义。 format是处理OpenAPI定义的工具的可选提示。

查看Describing Parameters指南了解详情。

如何在Node js Swagger.json中传递查询参数？

3 个答案: