refactor: replace writer(new DefaultPrettyPrinter()) with writerWithDefaultPrettyPrinter() (#5252)

vpelikh · ewaostrowska · web-flow · commit 7d14a26d5ad1 · 2026-07-30T10:33:44.000+02:00
* refactor: replace mapper().writer(new DefaultPrettyPrinter()) with writerWithDefaultPrettyPrinter()

* add test to show custom pretty printer is honored now

---------

Co-authored-by: Ewa Ostrowska &lt;ewa.ostrowska@smartbear.com&gt;
diff --git a/modules/swagger-core/src/main/java/io/swagger/v3/core/util/Json.java b/modules/swagger-core/src/main/java/io/swagger/v3/core/util/Json.java
@@ -1,6 +1,5 @@
 package io.swagger.v3.core.util;
 
-import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.ObjectWriter;
 import org.slf4j.Logger;
@@ -19,7 +18,7 @@ public static ObjectMapper mapper() {
     }
 
     public static ObjectWriter pretty() {
-        return mapper().writer(new DefaultPrettyPrinter());
+        return mapper().writerWithDefaultPrettyPrinter();
     }
 
     public static String pretty(Object o) {
diff --git a/modules/swagger-core/src/main/java/io/swagger/v3/core/util/Json31.java b/modules/swagger-core/src/main/java/io/swagger/v3/core/util/Json31.java
@@ -1,7 +1,6 @@
 package io.swagger.v3.core.util;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
-import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.ObjectWriter;
@@ -32,7 +31,7 @@ public static ObjectMapper converterMapper() {
     }
 
     public static ObjectWriter pretty() {
-        return mapper().writer(new DefaultPrettyPrinter());
+        return mapper().writerWithDefaultPrettyPrinter();
     }
 
     public static String pretty(Object o) {
diff --git a/modules/swagger-core/src/main/java/io/swagger/v3/core/util/Yaml.java b/modules/swagger-core/src/main/java/io/swagger/v3/core/util/Yaml.java
@@ -1,6 +1,5 @@
 package io.swagger.v3.core.util;
 
-import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.ObjectWriter;
 import org.slf4j.Logger;
@@ -19,7 +18,7 @@ public static ObjectMapper mapper() {
     }
 
     public static ObjectWriter pretty() {
-        return mapper().writer(new DefaultPrettyPrinter());
+        return mapper().writerWithDefaultPrettyPrinter();
     }
 
     public static String pretty(Object o) {
diff --git a/modules/swagger-core/src/main/java/io/swagger/v3/core/util/Yaml31.java b/modules/swagger-core/src/main/java/io/swagger/v3/core/util/Yaml31.java
@@ -1,7 +1,6 @@
 package io.swagger.v3.core.util;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
-import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.ObjectWriter;
 import io.swagger.v3.oas.models.media.Schema;
@@ -24,7 +23,7 @@ public static ObjectMapper mapper() {
     }
 
     public static ObjectWriter pretty() {
-        return mapper().writer(new DefaultPrettyPrinter());
+        return mapper().writerWithDefaultPrettyPrinter();
     }
 
     public static String pretty(Object o) {
diff --git a/modules/swagger-core/src/test/java/io/swagger/v3/core/resolving/SwaggerTestBase.java b/modules/swagger-core/src/test/java/io/swagger/v3/core/resolving/SwaggerTestBase.java
@@ -1,7 +1,6 @@
 package io.swagger.v3.core.resolving;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;
 import com.fasterxml.jackson.databind.DeserializationFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
@@ -29,7 +28,7 @@ protected ModelResolver modelResolver() {
 
     protected void prettyPrint(Object o) {
         try {
-            LOGGER.debug(mapper().writer(new DefaultPrettyPrinter()).writeValueAsString(o));
+            LOGGER.debug(mapper().writerWithDefaultPrettyPrinter().writeValueAsString(o));
         } catch (Exception e) {
             LOGGER.error("Failed to pretty print object", e);
         }
diff --git a/modules/swagger-core/src/test/java/io/swagger/v3/core/serialization/JsonSerializationTest.java b/modules/swagger-core/src/test/java/io/swagger/v3/core/serialization/JsonSerializationTest.java
@@ -1,6 +1,8 @@
 package io.swagger.v3.core.serialization;
 
 import com.fasterxml.jackson.core.JsonFactory;
+import com.fasterxml.jackson.core.util.DefaultIndenter;
+import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;
 import com.fasterxml.jackson.dataformat.yaml.JacksonYAMLParseException;
 import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
 import io.swagger.v3.core.matchers.SerializationMatchers;
@@ -23,6 +25,7 @@
 
 import static org.testng.Assert.assertEquals;
 import static org.testng.Assert.assertFalse;
+import static org.testng.Assert.assertTrue;
 
 public class JsonSerializationTest {
 
@@ -154,4 +157,33 @@ public void testSerializeYAMLWithCustomFactoryAndCodePointLimitReached() throws
 
         // then - Throw JacksonYAMLParseException
     }
+
+    @Test
+    public void testCustomPrettyPrinterIsHonored() {
+        //given
+        DefaultPrettyPrinter originalPrinter = (DefaultPrettyPrinter) Json.mapper().getSerializationConfig().getDefaultPrettyPrinter();
+        
+        try {
+            DefaultPrettyPrinter printer = new DefaultPrettyPrinter();
+            printer.indentObjectsWith(new DefaultIndenter("    ", "\n"));
+            Json.mapper().setDefaultPrettyPrinter(printer);
+
+            //when
+            OpenAPI openAPI = new OpenAPI()
+                    .info(new Info().title("Pet Store"));
+
+            String json = Json.pretty(openAPI);
+
+            //then
+            assertTrue(json.contains("{\n    \"openapi\""),
+                    "Custom four-space indentation should be honored");
+            assertTrue(json.contains("    \"info\" : {"), 
+                    "Nested objects should use four-space indentation");
+            assertTrue(json.contains("        \"title\" : \"Pet Store\""), 
+                    "Doubly-nested properties should use eight-space indentation");
+        } finally {
+            // Restore original pretty printer to avoid affecting other tests
+            Json.mapper().setDefaultPrettyPrinter(originalPrinter);
+        }
+    }
 }
diff --git a/modules/swagger-java17-support/src/test/java/io/swagger/v3/java17/resolving/SwaggerTestBase.java b/modules/swagger-java17-support/src/test/java/io/swagger/v3/java17/resolving/SwaggerTestBase.java
@@ -1,7 +1,6 @@
 package io.swagger.v3.java17.resolving;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;
 import com.fasterxml.jackson.databind.DeserializationFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
@@ -29,7 +28,7 @@ protected ModelResolver modelResolver() {
 
     protected void prettyPrint(Object o) {
         try {
-            LOGGER.debug(mapper().writer(new DefaultPrettyPrinter()).writeValueAsString(o));
+            LOGGER.debug(mapper().writerWithDefaultPrettyPrinter().writeValueAsString(o));
         } catch (Exception e) {
             LOGGER.error("Failed to pretty print object", e);
         }
diff --git a/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/integration/OpenApiServlet.java b/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/integration/OpenApiServlet.java
@@ -1,6 +1,5 @@
 package io.swagger.v3.jaxrs2.integration;
 
-import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;
 import io.swagger.v3.core.filter.OpenAPISpecFilter;
 import io.swagger.v3.core.filter.SpecFilter;
 import io.swagger.v3.jaxrs2.util.ServletUtils;
@@ -86,12 +85,12 @@ protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws Se
         if (type.equalsIgnoreCase("yaml")) {
             resp.setContentType(APPLICATION_YAML);
             try (PrintWriter pw = resp.getWriter()) {
-                pw.write(pretty ? ctx.getOutputYamlMapper().writer(new DefaultPrettyPrinter()).writeValueAsString(oas) : ctx.getOutputYamlMapper().writeValueAsString(oas));
+                pw.write(pretty ? ctx.getOutputYamlMapper().writerWithDefaultPrettyPrinter().writeValueAsString(oas) : ctx.getOutputYamlMapper().writeValueAsString(oas));
             }
         } else {
             resp.setContentType(APPLICATION_JSON);
             try (PrintWriter pw = resp.getWriter()) {
-                pw.write(pretty ? ctx.getOutputJsonMapper().writer(new DefaultPrettyPrinter()).writeValueAsString(oas) : ctx.getOutputJsonMapper().writeValueAsString(oas));
+                pw.write(pretty ? ctx.getOutputJsonMapper().writerWithDefaultPrettyPrinter().writeValueAsString(oas) : ctx.getOutputJsonMapper().writeValueAsString(oas));
             }
         }
 
diff --git a/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/integration/SwaggerLoader.java b/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/integration/SwaggerLoader.java
@@ -1,6 +1,5 @@
 package io.swagger.v3.jaxrs2.integration;
 
-import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;
 import io.swagger.v3.core.filter.OpenAPISpecFilter;
 import io.swagger.v3.core.filter.SpecFilter;
 import io.swagger.v3.core.util.Configuration;
@@ -401,14 +400,14 @@ public Map<String, String> resolve() throws Exception{
             String openapiYaml = null;
             if ("JSON".equals(outputFormat) || "JSONANDYAML".equals(outputFormat)) {
                 if (prettyPrint != null && prettyPrint) {
-                    openapiJson = context.getOutputJsonMapper().writer(new DefaultPrettyPrinter()).writeValueAsString(openAPI);
+                    openapiJson = context.getOutputJsonMapper().writerWithDefaultPrettyPrinter().writeValueAsString(openAPI);
                 } else {
                     openapiJson = context.getOutputJsonMapper().writeValueAsString(openAPI);
                 }
             }
             if ("YAML".equals(outputFormat) || "JSONANDYAML".equals(outputFormat)) {
                 if (prettyPrint != null && prettyPrint) {
-                    openapiYaml = context.getOutputYamlMapper().writer(new DefaultPrettyPrinter()).writeValueAsString(openAPI);
+                    openapiYaml = context.getOutputYamlMapper().writerWithDefaultPrettyPrinter().writeValueAsString(openAPI);
                 } else {
                     openapiYaml = context.getOutputYamlMapper().writeValueAsString(openAPI);
                 }
diff --git a/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/integration/resources/BaseOpenApiResource.java b/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/integration/resources/BaseOpenApiResource.java
@@ -1,6 +1,5 @@
 package io.swagger.v3.jaxrs2.integration.resources;
 
-import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;
 import io.swagger.v3.core.filter.OpenAPISpecFilter;
 import io.swagger.v3.core.filter.SpecFilter;
 import io.swagger.v3.jaxrs2.integration.JaxrsOpenApiContextBuilder;
@@ -71,14 +70,14 @@ protected Response getOpenApi(HttpHeaders headers,
         if (StringUtils.isNotBlank(type) && type.trim().equalsIgnoreCase("yaml")) {
             return Response.status(Response.Status.OK)
                     .entity(pretty ?
-                            ctx.getOutputYamlMapper().writer(new DefaultPrettyPrinter()).writeValueAsString(oas) :
+                            ctx.getOutputYamlMapper().writerWithDefaultPrettyPrinter().writeValueAsString(oas) :
                             ctx.getOutputYamlMapper().writeValueAsString(oas))
                     .type("application/yaml")
                     .build();
         } else {
             return Response.status(Response.Status.OK)
                     .entity(pretty ?
-                            ctx.getOutputJsonMapper().writer(new DefaultPrettyPrinter()).writeValueAsString(oas) :
+                            ctx.getOutputJsonMapper().writerWithDefaultPrettyPrinter().writeValueAsString(oas) :
                             ctx.getOutputJsonMapper().writeValueAsString(oas))
                     .type(MediaType.APPLICATION_JSON_TYPE)
                     .build();
diff --git a/modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/BootstrapServlet.java b/modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/BootstrapServlet.java
@@ -1,6 +1,5 @@
 package io.swagger.v3.jaxrs2;
 
-import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;
 import io.swagger.v3.jaxrs2.integration.JaxrsOpenApiContextBuilder;
 import io.swagger.v3.oas.integration.OpenApiConfigurationException;
 import io.swagger.v3.oas.integration.OpenApiContextLocator;
@@ -68,7 +67,7 @@ protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws Se
 
         resp.setContentType("application/yaml");
         try (PrintWriter pw = resp.getWriter()) {
-            pw.write(ctx.getOutputYamlMapper().writer(new DefaultPrettyPrinter()).writeValueAsString(oas));
+            pw.write(ctx.getOutputYamlMapper().writerWithDefaultPrettyPrinter().writeValueAsString(oas));
         }
     }
 }
diff --git a/modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/integration/SortedOutputTest.java b/modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/integration/SortedOutputTest.java
@@ -5,7 +5,6 @@
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
-import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;
 import com.fasterxml.jackson.databind.MapperFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
@@ -71,7 +70,7 @@ public void sortOutputTest() throws Exception {
                 .init();
 
         OpenAPI openApi = ctx.read();
-        String sorted = ctx.getOutputYamlMapper().writer(new DefaultPrettyPrinter()).writeValueAsString(openApi);
+        String sorted = ctx.getOutputYamlMapper().writerWithDefaultPrettyPrinter().writeValueAsString(openApi);
 
         openApiConfiguration = new SwaggerConfiguration()
                 .resourcePackages(Collections.singleton("com.my.sorted.resources"));
@@ -80,7 +79,7 @@ public void sortOutputTest() throws Exception {
                 .openApiConfiguration(openApiConfiguration)
                 .init();
 
-        String notSorted = ctx.getOutputYamlMapper().writer(new DefaultPrettyPrinter()).writeValueAsString(openApi);
+        String notSorted = ctx.getOutputYamlMapper().writerWithDefaultPrettyPrinter().writeValueAsString(openApi);
 
         assertEquals(sorted, expectedSorted);
         assertEquals(notSorted, expectedNotSorted);
@@ -176,7 +175,7 @@ public void configOutputTest() throws Exception {
                 .init();
 
         OpenAPI openApi = ctx.read();
-        String sorted = ctx.getOutputYamlMapper().writer(new DefaultPrettyPrinter()).writeValueAsString(openApi);
+        String sorted = ctx.getOutputYamlMapper().writerWithDefaultPrettyPrinter().writeValueAsString(openApi);
 
         openApiConfiguration = new SwaggerConfiguration()
                 .resourcePackages(Collections.singleton("com.my.sorted.resources"));
@@ -185,7 +184,7 @@ public void configOutputTest() throws Exception {
                 .openApiConfiguration(openApiConfiguration)
                 .init();
 
-        String notSorted = ctx.getOutputYamlMapper().writer(new DefaultPrettyPrinter()).writeValueAsString(openApi);
+        String notSorted = ctx.getOutputYamlMapper().writerWithDefaultPrettyPrinter().writeValueAsString(openApi);
 
         assertEquals(sorted, expectedSorted);
         assertEquals(notSorted, expectedNotSorted);
diff --git a/modules/swagger-maven-plugin/src/main/java/io/swagger/v3/plugin/maven/SwaggerMojo.java b/modules/swagger-maven-plugin/src/main/java/io/swagger/v3/plugin/maven/SwaggerMojo.java
@@ -1,6 +1,5 @@
 package io.swagger.v3.plugin.maven;
 
-import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;
 import io.swagger.v3.core.filter.OpenAPISpecFilter;
 import io.swagger.v3.core.filter.SpecFilter;
 import io.swagger.v3.core.util.Configuration;
@@ -101,14 +100,14 @@ public void execute() throws MojoExecutionException, MojoFailureException {
             String openapiYaml = null;
             if (Format.JSON.equals(outputFormat) || Format.JSONANDYAML.equals(outputFormat)) {
                 if (config.isPrettyPrint() != null && config.isPrettyPrint()) {
-                    openapiJson = context.getOutputJsonMapper().writer(new DefaultPrettyPrinter()).writeValueAsString(openAPI);
+                    openapiJson = context.getOutputJsonMapper().writerWithDefaultPrettyPrinter().writeValueAsString(openAPI);
                 } else {
                     openapiJson = context.getOutputJsonMapper().writeValueAsString(openAPI);
                 }
             }
             if (Format.YAML.equals(outputFormat) || Format.JSONANDYAML.equals(outputFormat)) {
                 if (config.isPrettyPrint() != null && config.isPrettyPrint()) {
-                    openapiYaml = context.getOutputYamlMapper().writer(new DefaultPrettyPrinter()).writeValueAsString(openAPI);
+                    openapiYaml = context.getOutputYamlMapper().writerWithDefaultPrettyPrinter().writeValueAsString(openAPI);
                 } else {
                     openapiYaml = context.getOutputYamlMapper().writeValueAsString(openAPI);
                 }
diff --git a/modules/swagger-models/src/test/java/io/swagger/test/SimpleBuilderTest.java b/modules/swagger-models/src/test/java/io/swagger/test/SimpleBuilderTest.java
@@ -1,7 +1,6 @@
 package io.swagger.test;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;
 import com.fasterxml.jackson.databind.DeserializationFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
@@ -134,6 +133,6 @@ public static String writeJson(Object value) throws Exception {
         mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
         mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
 
-        return mapper.writer(new DefaultPrettyPrinter()).writeValueAsString(value);
+        return mapper.writerWithDefaultPrettyPrinter().writeValueAsString(value);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,5 @@`
`1`	`1`	`package io.swagger.v3.core.util;`
`2`	`2`
`3`		`-import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;`
`4`	`3`	`import com.fasterxml.jackson.databind.ObjectMapper;`
`5`	`4`	`import com.fasterxml.jackson.databind.ObjectWriter;`
`6`	`5`	`import org.slf4j.Logger;`
`@@ -19,7 +18,7 @@ public static ObjectMapper mapper() {`
`19`	`18`	`}`
`20`	`19`
`21`	`20`	`public static ObjectWriter pretty() {`
`22`		`- return mapper().writer(new DefaultPrettyPrinter());`
	`21`	`+ return mapper().writerWithDefaultPrettyPrinter();`
`23`	`22`	`}`
`24`	`23`
`25`	`24`	`public static String pretty(Object o) {`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,6 @@`
`1`	`1`	`package io.swagger.v3.core.util;`
`2`	`2`
`3`	`3`	`import com.fasterxml.jackson.core.JsonProcessingException;`
`4`		`-import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;`
`5`	`4`	`import com.fasterxml.jackson.databind.JsonNode;`
`6`	`5`	`import com.fasterxml.jackson.databind.ObjectMapper;`
`7`	`6`	`import com.fasterxml.jackson.databind.ObjectWriter;`
`@@ -32,7 +31,7 @@ public static ObjectMapper converterMapper() {`
`32`	`31`	`}`
`33`	`32`
`34`	`33`	`public static ObjectWriter pretty() {`
`35`		`- return mapper().writer(new DefaultPrettyPrinter());`
	`34`	`+ return mapper().writerWithDefaultPrettyPrinter();`
`36`	`35`	`}`
`37`	`36`
`38`	`37`	`public static String pretty(Object o) {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,5 @@`
`1`	`1`	`package io.swagger.v3.jaxrs2.integration;`
`2`	`2`
`3`		`-import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;`
`4`	`3`	`import io.swagger.v3.core.filter.OpenAPISpecFilter;`
`5`	`4`	`import io.swagger.v3.core.filter.SpecFilter;`
`6`	`5`	`import io.swagger.v3.jaxrs2.util.ServletUtils;`
`@@ -86,12 +85,12 @@ protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws Se`
`86`	`85`	`if (type.equalsIgnoreCase("yaml")) {`
`87`	`86`	`resp.setContentType(APPLICATION_YAML);`
`88`	`87`	`try (PrintWriter pw = resp.getWriter()) {`
`89`		`- pw.write(pretty ? ctx.getOutputYamlMapper().writer(new DefaultPrettyPrinter()).writeValueAsString(oas) : ctx.getOutputYamlMapper().writeValueAsString(oas));`
	`88`	`+ pw.write(pretty ? ctx.getOutputYamlMapper().writerWithDefaultPrettyPrinter().writeValueAsString(oas) : ctx.getOutputYamlMapper().writeValueAsString(oas));`
`90`	`89`	`}`
`91`	`90`	`} else {`
`92`	`91`	`resp.setContentType(APPLICATION_JSON);`
`93`	`92`	`try (PrintWriter pw = resp.getWriter()) {`
`94`		`- pw.write(pretty ? ctx.getOutputJsonMapper().writer(new DefaultPrettyPrinter()).writeValueAsString(oas) : ctx.getOutputJsonMapper().writeValueAsString(oas));`
	`93`	`+ pw.write(pretty ? ctx.getOutputJsonMapper().writerWithDefaultPrettyPrinter().writeValueAsString(oas) : ctx.getOutputJsonMapper().writeValueAsString(oas));`
`95`	`94`	`}`
`96`	`95`	`}`
`97`	`96`