éWeird YAML tag in section OpenAPI spec file. Fixes #774

Author: bnasslahsen

springdoc-openapi-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java

@@ -40,8 +40,12 @@
 import java.util.stream.Collectors;
 
 import com.fasterxml.jackson.annotation.JsonView;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
+import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator.Feature;
 import io.swagger.v3.core.filter.SpecFilter;
 import io.swagger.v3.core.util.ReflectionUtils;
+import io.swagger.v3.core.util.Yaml;
 import io.swagger.v3.oas.annotations.Hidden;
 import io.swagger.v3.oas.annotations.callbacks.Callback;
 import io.swagger.v3.oas.annotations.enums.ParameterIn;
@@ -953,4 +957,16 @@ protected void initOpenAPIBuilder() {
 			openAPIBuilder = openAPIBuilderObjectFactory.getObject();
 		}
 	}
+
+	/**
+	 * Gets yaml mapper.
+	 *
+	 * @return the yaml mapper
+	 */
+	protected ObjectMapper getYamlMapper() {
+		ObjectMapper objectMapper  =  Yaml.mapper();
+		YAMLFactory factory = (YAMLFactory) objectMapper.getFactory();
+		factory.configure(Feature.USE_NATIVE_TYPE_ID, false);
+		return objectMapper;
+	}
 }

springdoc-openapi-webflux-core/src/main/java/org/springdoc/webflux/api/OpenApiResource.java

@@ -28,6 +28,7 @@
 import java.util.Set;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
 import io.swagger.v3.core.util.Json;
 import io.swagger.v3.core.util.PathUtils;
 import io.swagger.v3.core.util.Yaml;
@@ -164,9 +165,9 @@ public Mono<String> openapiYaml(ServerHttpRequest serverHttpRequest,
 		calculateServerUrl(serverHttpRequest, apiDocsUrl);
 		OpenAPI openAPI = this.getOpenApi();
 		if (!springDocConfigProperties.isWriterWithDefaultPrettyPrinter())
-			return Mono.just(Yaml.mapper().writeValueAsString(openAPI));
+			return Mono.just(getYamlMapper().writeValueAsString(openAPI));
 		else
-			return Mono.just(Yaml.mapper().writerWithDefaultPrettyPrinter().writeValueAsString(openAPI));
+			return Mono.just(getYamlMapper().writerWithDefaultPrettyPrinter().writeValueAsString(openAPI));
 	}
 
 	@Override

springdoc-openapi-webmvc-core/src/main/java/org/springdoc/webmvc/api/OpenApiResource.java

@@ -199,9 +199,9 @@ public String openapiYaml(HttpServletRequest request, @Value(DEFAULT_API_DOCS_UR
 		calculateServerUrl(request, apiDocsUrl);
 		OpenAPI openAPI = this.getOpenApi();
 		if (!springDocConfigProperties.isWriterWithDefaultPrettyPrinter())
-			return Yaml.mapper().writeValueAsString(openAPI);
+			return getYamlMapper().writeValueAsString(openAPI);
 		else
-			return Yaml.mapper().writerWithDefaultPrettyPrinter().writeValueAsString(openAPI);
+			return getYamlMapper().writerWithDefaultPrettyPrinter().writeValueAsString(openAPI);
 	}
 
 	@Override

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app127/AbstractObject.java

@@ -0,0 +1,31 @@
+package test.org.springdoc.api.app127;
+
+import com.fasterxml.jackson.annotation.JsonSubTypes;
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+
+@JsonTypeInfo(use = JsonTypeInfo.Id.NAME,
+    include = JsonTypeInfo.As.EXISTING_PROPERTY,
+    property = "type",
+    visible = true
+)
+@JsonSubTypes({
+    @JsonSubTypes.Type(value = ConcreteObjectA.class, name = "Type A")
+})
+public abstract class AbstractObject {
+
+  private final ConcreteType type;
+  private final String name;
+
+  protected AbstractObject(ConcreteType type, String name) {
+    this.type = type;
+    this.name = name;
+  }
+
+  public ConcreteType getType() {
+    return type;
+  }
+
+  public String getName() {
+    return name;
+  }
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app127/ConcreteObjectA.java

@@ -0,0 +1,15 @@
+package test.org.springdoc.api.app127;
+
+public class ConcreteObjectA extends AbstractObject {
+
+  private final String description;
+
+  public ConcreteObjectA(String name, String description) {
+    super(ConcreteType.TYPE_A, name);
+    this.description = description;
+  }
+
+  public String getDescription() {
+    return description;
+  }
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app127/ConcreteType.java

@@ -0,0 +1,16 @@
+package test.org.springdoc.api.app127;
+
+public enum ConcreteType {
+  TYPE_A("Type A"),
+  TYPE_B("Type B");
+
+  private final String name;
+
+  ConcreteType(String name) {
+    this.name = name;
+  }
+
+  public String getName() {
+    return name;
+  }
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app127/Controller.java

@@ -0,0 +1,28 @@
+package test.org.springdoc.api.app127;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.ExampleObject;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+
+import org.springframework.http.MediaType;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class Controller {
+
+  @Operation(summary = "Test Bug", responses = {
+      @ApiResponse(responseCode = "200", description = "OK",
+          content = @Content(
+              schema = @Schema(implementation = Umbrella.class),
+              examples = @ExampleObject(ref = "#/components/examples/umbrellaExample", name = "Example with weird YAML tag")
+          )
+      )
+  })
+  @GetMapping(value = "/bug", produces = MediaType.APPLICATION_JSON_VALUE)
+  public Umbrella bug() {
+    return new Umbrella(new ConcreteObjectA("a", "b"));
+  }
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app127/SpringDocApp127Test.java

@@ -0,0 +1,53 @@
+/*
+ *
+ *  *
+ *  *  *
+ *  *  *  * Copyright 2019-2020 the original author or authors.
+ *  *  *  *
+ *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
+ *  *  *  * you may not use this file except in compliance with the License.
+ *  *  *  * You may obtain a copy of the License at
+ *  *  *  *
+ *  *  *  *      https://www.apache.org/licenses/LICENSE-2.0
+ *  *  *  *
+ *  *  *  * Unless required by applicable law or agreed to in writing, software
+ *  *  *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  *  *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  *  *  * See the License for the specific language governing permissions and
+ *  *  *  * limitations under the License.
+ *  *  *
+ *  *
+ *
+ *
+ */
+package test.org.springdoc.api.app127;
+
+import org.junit.Assert;
+import org.junit.jupiter.api.Test;
+import org.springdoc.core.Constants;
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.test.web.servlet.MvcResult;
+
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+
+/**
+ * Tests Spring meta-annotations as method parameters
+ */
+public class SpringDocApp127Test extends AbstractSpringDocTest {
+
+	@SpringBootApplication
+	static class SpringDocTestApp {}
+
+	@Test
+	public void testApp() throws Exception {
+		className = getClass().getSimpleName();
+		String testNumber = className.replaceAll("[^0-9]", "");
+		MvcResult mockMvcResult = mockMvc.perform(get(Constants.DEFAULT_API_DOCS_URL+".yaml")).andExpect(status().isOk()).andReturn();
+		String result = mockMvcResult.getResponse().getContentAsString();
+		Assert.assertTrue(!result.contains("!<Type A>"));
+	}
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app127/Umbrella.java

@@ -0,0 +1,17 @@
+package test.org.springdoc.api.app127;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+
+public class Umbrella {
+
+  @Schema(description = "This reference to abstract class causes weird YAML tag to be added", anyOf = ConcreteObjectA.class)
+  private final AbstractObject object;
+
+  public Umbrella(AbstractObject object) {
+    this.object = object;
+  }
+
+  public AbstractObject getObject() {
+    return object;
+  }
+}