Add support for jakarta.validation.constraints.Email

Author: jobayle

modules/swagger-core/src/main/java/io/swagger/v3/core/jackson/ModelResolver.java

@@ -64,6 +64,7 @@
 import io.swagger.v3.oas.models.media.StringSchema;
 import io.swagger.v3.oas.models.media.UUIDSchema;
 import io.swagger.v3.oas.models.media.XML;
+import javax.validation.constraints.Email;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.math.NumberUtils;
 import org.slf4j.Logger;
@@ -1851,6 +1852,20 @@ protected boolean applyBeanValidatorAnnotations(Schema property, Annotation[] an
                 }
             }
         }
+        if (annos.containsKey("javax.validation.constraints.Email")) {
+            Email email = (Email) annos.get("javax.validation.constraints.Email");
+            boolean apply = checkGroupValidation(email.groups(), invocationGroups, acceptNoGroups);
+            if (apply) {
+                if (isStringSchema(property)) {
+                    property.setFormat("email");
+                    modified = true;
+                }
+                if (property.getItems() != null && isStringSchema(property.getItems())) {
+                    property.getItems().setFormat("email");
+                    modified = true;
+                }
+            }
+        }
         if (validatorProcessor != null && validatorProcessor.getMode().equals(ValidatorProcessor.MODE.AFTER)) {
             modified = validatorProcessor.applyBeanValidatorAnnotations(property, annotations, parent, applyNotNullAnnotations) || modified;
         }
@@ -1961,6 +1976,12 @@ protected boolean applyBeanValidatorAnnotationsNoGroups(Schema property, Annotat
                 modified = true;
             }
         }
+        if (annos.containsKey("javax.validation.constraints.Email")) {
+            if (isStringSchema(property)) {
+                property.setFormat("email");
+                modified = true;
+            }
+        }
         return modified;
     }
 

modules/swagger-core/src/test/java/io/swagger/v3/core/oas/models/BeanValidationsModel.java

@@ -2,6 +2,7 @@
 
 import javax.validation.constraints.DecimalMax;
 import javax.validation.constraints.DecimalMin;
+import javax.validation.constraints.Email;
 import javax.validation.constraints.Max;
 import javax.validation.constraints.Min;
 import javax.validation.constraints.NotNull;
@@ -18,14 +19,15 @@ public class BeanValidationsModel {
     @Max(99)
     protected Integer age;
 
+    @Pattern(regexp = "(?![-._])[-._a-zA-Z0-9]{3,32}")
     protected String username;
 
     @Size(min = 6, max = 20)
     protected String password;
 
     protected String passwordHint;
 
-    @Pattern(regexp = "(.+?)@(.+?)")
+    @Email
     protected String email;
 
     @DecimalMin(value = "0.1", inclusive = false)

modules/swagger-core/src/test/java/io/swagger/v3/core/resolving/BeanValidatorTest.java

@@ -3,6 +3,7 @@
 import io.swagger.v3.core.converter.ModelConverters;
 import io.swagger.v3.core.oas.models.BeanValidationsModel;
 import io.swagger.v3.oas.models.media.ArraySchema;
+import io.swagger.v3.oas.models.media.EmailSchema;
 import io.swagger.v3.oas.models.media.IntegerSchema;
 import io.swagger.v3.oas.models.media.NumberSchema;
 import io.swagger.v3.oas.models.media.Schema;
@@ -23,6 +24,9 @@ public void readBeanValidatorTest() {
 
         Assert.assertTrue(model.getRequired().contains("id"));
 
+        final StringSchema username = (StringSchema) properties.get("username");
+        Assert.assertEquals((String) username.getPattern(), "(?![-._])[-._a-zA-Z0-9]{3,32}");
+
         final IntegerSchema age = (IntegerSchema) properties.get("age");
         Assert.assertEquals(age.getMinimum(), new BigDecimal(13.0));
         Assert.assertEquals(age.getMaximum(), new BigDecimal(99.0));
@@ -31,8 +35,8 @@ public void readBeanValidatorTest() {
         Assert.assertEquals((int) password.getMinLength(), 6);
         Assert.assertEquals((int) password.getMaxLength(), 20);
 
-        final StringSchema email = (StringSchema) properties.get("email");
-        Assert.assertEquals((String) email.getPattern(), "(.+?)@(.+?)");
+        final EmailSchema email = (EmailSchema) properties.get("email");
+        Assert.assertEquals((String) email.getFormat(), "email");
 
         final NumberSchema minBalance = (NumberSchema) properties.get("minBalance");
         Assert.assertTrue(minBalance.getExclusiveMinimum());