Swagger验证,电子邮件类型不起作用

时间:2018-02-16 07:21:38

标签: swagger-ui swagger-node-express

我在.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

有人能指出正确的方法吗?

3 个答案:

答案 0 :(得分:0)

名称只是任何资源的字段。例如,如果您有用户,则定义将如下所示:

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

答案 1 :(得分:0)

在模式中,您必须放置示例的值。有时,电子邮件格式的解释不正确,这与Swashbuckle Nuget库有关。我的意思是,即使格式为电子邮件,也无法在Swagger-UI中生成正确的示例值。

encoding="latin-1"

答案 2 :(得分:0)

请参阅This release note

它说,默认情况下,格式验证是禁用的,对于更复杂的格式,例如电子邮件地址,支持可能仍然会有很大差异。尚不清楚有多少实施方案提供过这种级别的支持。