Как передать параметры запроса в Node js Swagger.json?

Question

Я пытаюсь передать параметры запроса из URL-адреса запроса в NodeJS swagger.json.Но я получаю неопределенный.

вот URL reset/password?email=myname@mail.com

На NodeJS swagger "параметры": [{"name": "Параметры","in": "",
"обязательный": true, "type": "string", "schema": {"$ ref": "# / definitions / resetPassword",}}],

Answer 1

Ваше определение параметра должно выглядеть следующим образом:

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

in: query указывает, что параметр передается в строке запроса.

name: ... - это имя параметра (в вашемпример - email).

type: string и format: email указывают тип параметра.Для параметров запроса требуется примитив type (строка, число и т. Д.) Или тип массива, но они не могут $ref определения.format - это дополнительная подсказка для инструментов, которые будут обрабатывать ваше определение OpenAPI.

Дополнительные сведения см. В руководстве Описание параметров .

Answer 2

Пример для передачи параметра запроса через JSON:

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

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

Answer 3

Изменить этот код: "in": "query"