Проверка Swagger, тип электронной почты не работает

Question

Проверка Swagger, тип электронной почты не работает

Я пытался с обоими способами в .yaml файл,

email:
  name: email 
  description: Client email
  required: true
  type: string
  format: email
  in: formData


email:
  name: email 
  description: Client email
  required: true
  type: email
  in: formData

Кто-нибудь может указать правильный путь?

1

swagger-ui swagger-node-express

Источник

user6348841 16 фев '18 в 07:21

1 ответ

Другие вопросы по тегам swagger-ui swagger-node-express

user819963 12 дек '19 в 20:25 2019-12-12 20:25 · Answer 1 · 2019-12-12 20:25

В схеме вы должны указать значение примера. Иногда формат электронной почты плохо интерпретируется, это бывает у меня с библиотекой Swashbuckle Nuget. Я имею в виду, что даже если используется формат электронной почты, в Swagger-UI не будет создано правильное значение примера.

email:
  name: email 
  description: Client email
  required: true
  type: string
  format: email
  example: user@example.com
  in: formData

user9056546 20 мар '18 в 20:42 2018-03-20 20:42 · Answer 2 · 2018-03-20 20:42

Имя - это только поле любого ресурса. Например, если у вас есть пользователь, определение будет таким:

User:
  title: Simple user
  type: object
  properties:
    email:
      type: string
      format: email
    password:
      type: string

1

Источник

user9056546 20 мар '18 в 20:42

user2652269 07 апр '20 в 13:20 2020-04-07 13:20 · Answer 3 · 2020-04-07 13:20

Пожалуйста, обратитесь к этому примечанию к выпуску

В нем говорится, что по умолчанию проверка формата отключена, а для более сложных форматов, таких как адреса электронной почты, поддержка, вероятно, по-прежнему будет значительно отличаться. Неясно, сколько реализаций когда-либо обеспечивали такой уровень поддержки.