Merge pull request #3380 from swagger-api/ticket-3365

refs #3365 - fix schema example resolving edge case strings

Author: frantuma

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

@@ -30,6 +30,7 @@
 import io.swagger.v3.core.util.AnnotationsUtils;
 import io.swagger.v3.core.util.Constants;
 import io.swagger.v3.core.util.Json;
+import io.swagger.v3.core.util.ObjectMapperFactory;
 import io.swagger.v3.core.util.PrimitiveType;
 import io.swagger.v3.core.util.ReflectionUtils;
 import io.swagger.v3.oas.annotations.media.DiscriminatorMapping;
@@ -1424,7 +1425,8 @@ protected Object resolveExample(Annotated a, Annotation[] annotations, io.swagge
         if (schema != null) {
             if (!schema.example().isEmpty()) {
                 try {
-                    return Json.mapper().readTree(schema.example());
+                    ObjectMapper mapper = ObjectMapperFactory.buildStrictGenericObjectMapper();
+                    return mapper.readTree(schema.example());
                 } catch (IOException e) {
                     return schema.example();
                 }

modules/swagger-core/src/main/java/io/swagger/v3/core/util/AnnotationsUtils.java

@@ -3,6 +3,7 @@
 import com.fasterxml.jackson.annotation.JsonView;
 import com.fasterxml.jackson.databind.JavaType;
 import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.introspect.Annotated;
 import io.swagger.v3.core.converter.AnnotatedType;
 import io.swagger.v3.core.converter.ModelConverters;
@@ -347,7 +348,8 @@ private static boolean resolveExample(Example exampleObject, ExampleObject examp
         if (StringUtils.isNotBlank(example.value())) {
             isEmpty = false;
             try {
-                exampleObject.setValue(Json.mapper().readTree(example.value()));
+                ObjectMapper mapper = ObjectMapperFactory.buildStrictGenericObjectMapper();
+                exampleObject.setValue(mapper.readTree(example.value()));
             } catch (IOException e) {
                 exampleObject.setValue(example.value());
             }
@@ -1895,4 +1897,5 @@ public Extension[] extensions() {
 
         return (io.swagger.v3.oas.annotations.media.ArraySchema)newArraySchema;
     }
+
 }

modules/swagger-core/src/main/java/io/swagger/v3/core/util/ObjectMapperFactory.java

@@ -143,4 +143,17 @@ public JsonSerializer<?> modifySerializer(
 
         return mapper;
     }
+
+    public static ObjectMapper buildStrictGenericObjectMapper() {
+        ObjectMapper mapper = new ObjectMapper();
+        mapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
+        mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
+        mapper.configure(SerializationFeature.WRITE_ENUMS_USING_TO_STRING, true);
+        mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
+        mapper.configure(SerializationFeature.WRITE_NULL_MAP_VALUES, false);
+        mapper.configure(DeserializationFeature.FAIL_ON_TRAILING_TOKENS, true);
+        mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
+        return mapper;
+    }
+
 }

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

@@ -0,0 +1,70 @@
+package io.swagger.v3.core.resolving;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import io.swagger.v3.core.converter.AnnotatedType;
+import io.swagger.v3.core.converter.ModelConverterContextImpl;
+import io.swagger.v3.core.jackson.ModelResolver;
+import io.swagger.v3.core.matchers.SerializationMatchers;
+import io.swagger.v3.oas.models.media.Schema;
+import org.testng.annotations.BeforeMethod;
+import org.testng.annotations.Test;
+
+import static org.testng.Assert.assertNotNull;
+
+public class Ticket3365Test extends SwaggerTestBase {
+
+    private ModelResolver modelResolver;
+    private ModelConverterContextImpl context;
+
+    @BeforeMethod
+    public void beforeMethod() {
+        modelResolver = new ModelResolver(new ObjectMapper());
+        context = new ModelConverterContextImpl(modelResolver);
+    }
+
+    @Test
+    public void testTicket3365() {
+        Schema model = context.resolve(new AnnotatedType(ExampleWithJson.class));
+        assertNotNull(model);
+        SerializationMatchers.assertEqualsToYaml(model, "required:\n" +
+                "- param1\n" +
+                "type: object\n" +
+                "properties:\n" +
+                "  param1:\n" +
+                "    title: Cron formatted invoice schedule\n" +
+                "    type: object\n" +
+                "    example:\n" +
+                "      type: array\n" +
+                "      items:\n" +
+                "        type: string\n" +
+                "        format: byte");
+
+        model = context.resolve(new AnnotatedType(ExampleStartingWithInteger.class));
+        assertNotNull(model);
+        SerializationMatchers.assertEqualsToYaml(model, "required:\n" +
+                "- param1\n" +
+                "type: object\n" +
+                "properties:\n" +
+                "  param1:\n" +
+                "    title: Cron formatted invoice schedule\n" +
+                "    type: string\n" +
+                "    example: 0 0 5 * *\n");
+    }
+
+    static class ExampleStartingWithInteger  {
+        @io.swagger.v3.oas.annotations.media.Schema(
+                required = true,
+                title = "Cron formatted invoice schedule",
+                example = "0 0 5 * *"
+        )
+        public String param1;
+    }
+    static class ExampleWithJson  {
+        @io.swagger.v3.oas.annotations.media.Schema(
+                required = true,
+                title = "Cron formatted invoice schedule",
+                example = "{\"type\": \"array\", \"items\": {\"type\" : \"string\", \"format\": \"byte\"}}"
+        )
+        public Object param1;
+    }
+}