如何在Swagger Open API 3.0规范中定义电子邮件格式？

Question

在我的swagger Open API文档中，我给出了如下的对象定义:

"definitions": {
  "User": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64"
          },
     
          "firstName": {
            "type": "string"
          },
        
          "email": {
            "type": "string"
          },
          "shipDate": {
            "type": "string",
           "format": "date-time"
          },
         "status": {
          "type": "string",
          "description": "Order Status",
        "enum": [
          "placed",
          "approved",
          "delivered"
        ]
      }
}

我找不到电子邮件地址的格式，如:

 "email": {
        "type": "string",
        "format" : "####"
      }

我看了官方文件，他们说:

即使本规范未定义，也可以使用“email”、“uuid”等格式。未附带格式属性的类型遵循JSON模式中的类型定义。

我正在努力实现这一点，任何提示我如何才能实现这一点？

Answer 1

您可以使用正则表达式模式来限制可接受的电子邮件域。例如，如果电子邮件必须以. io结尾，您可以使用\。[Ii][Oo]$模式：

"email": {
  "type": "string",
  "format": "email",
  "pattern": "\\.[Ii][Oo]$"
}

请注意，字符串中的< code>\字符被转义为< code>\\。