Swagger validation , email type not working

Question

I tried with both way in .yaml file ,

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

can some one point out the correct way?

1st example (`type: string` + `format: email`) is correct. What do you mean by "not working"? — Helen, Feb 16 '18 at 11:24
@Helen in swagger ui , allow to input any value when execute API — Asanka, Feb 17 '18 at 02:14

score 2 · Answer 1 · answered Dec 12 '19 at 17:25

At the schema, you have to put the value of the example. Sometimes the email format is not interpreted well, it happens me with the Swashbuckle Nuget library. I mean, even if the format is email, it wouldn't generate the right example value in Swagger-UI.

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

score 1 · Answer 2 · edited Mar 20 '18 at 21:05

1

Name is only a field of any resource. If you have a user, for example, the definition will be like this:

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

edited Mar 20 '18 at 21:05

IKavanagh

6,089
11
42
47

answered Mar 20 '18 at 20:42

SebaReal

161
2
7

score 0 · Answer 3 · answered Apr 07 '20 at 10:20

Please refer This release note

It says that by default format validation is disabled and for more complex formats such as email addresses, support will probably still vary significantly. It’s unclear how many implementations have ever provided this level of support.

Swagger validation , email type not working

3 Answers3