[Feature] Pretty print OpenApi spec. Fixes #703

Author: bnasslahsen

springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfigProperties.java

@@ -62,6 +62,8 @@ public class SpringDocConfigProperties {
 
 	private boolean removeBrokenReferenceDefinitions = true;
 
+	private boolean writerWithDefaultPrettyPrinter;
+
 	private String defaultConsumesMediaType = MediaType.APPLICATION_JSON_VALUE;
 
 	private String defaultProducesMediaType = MediaType.ALL_VALUE;
@@ -194,6 +196,14 @@ public void setRemoveBrokenReferenceDefinitions(boolean removeBrokenReferenceDef
 		this.removeBrokenReferenceDefinitions = removeBrokenReferenceDefinitions;
 	}
 
+	public boolean isWriterWithDefaultPrettyPrinter() {
+		return writerWithDefaultPrettyPrinter;
+	}
+
+	public void setWriterWithDefaultPrettyPrinter(boolean writerWithDefaultPrettyPrinter) {
+		this.writerWithDefaultPrettyPrinter = writerWithDefaultPrettyPrinter;
+	}
+
 	public static class Webjars {
 		private String prefix = DEFAULT_WEB_JARS_PREFIX_URL;
 

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

@@ -94,7 +94,10 @@ public Mono<String> openapiJson(ServerHttpRequest serverHttpRequest, @Value(API_
 			throws JsonProcessingException {
 		calculateServerUrl(serverHttpRequest, apiDocsUrl);
 		OpenAPI openAPI = this.getOpenApi();
-		return Mono.just(Json.mapper().writeValueAsString(openAPI));
+		if (!springDocConfigProperties.isWriterWithDefaultPrettyPrinter())
+			return Mono.just(Json.mapper().writeValueAsString(openAPI));
+		else
+			return Mono.just(Json.mapper().writerWithDefaultPrettyPrinter().writeValueAsString(openAPI));
 	}
 
 	@Operation(hidden = true)
@@ -103,7 +106,10 @@ public Mono<String> openapiYaml(ServerHttpRequest serverHttpRequest,
 			@Value(DEFAULT_API_DOCS_URL_YAML) String apiDocsUrl) throws JsonProcessingException {
 		calculateServerUrl(serverHttpRequest, apiDocsUrl);
 		OpenAPI openAPI = this.getOpenApi();
-		return Mono.just(Yaml.mapper().writeValueAsString(openAPI));
+		if (!springDocConfigProperties.isWriterWithDefaultPrettyPrinter())
+			return Mono.just(Yaml.mapper().writeValueAsString(openAPI));
+		else
+			return Mono.just(Yaml.mapper().writerWithDefaultPrettyPrinter().writeValueAsString(openAPI));
 	}
 
 	@Override

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

@@ -95,7 +95,7 @@ public OpenApiResource(String groupName, OpenAPIBuilder openAPIBuilder, Abstract
 		this.servletContextProvider = servletContextProvider;
 		this.springSecurityOAuth2Provider = springSecurityOAuth2Provider;
 		this.routerFunctionProvider = routerFunctionProvider;
-		this.repositoryRestResourceProvider=repositoryRestResourceProvider;
+		this.repositoryRestResourceProvider = repositoryRestResourceProvider;
 	}
 
 	@Autowired
@@ -114,7 +114,7 @@ public OpenApiResource(OpenAPIBuilder openAPIBuilder, AbstractRequestBuilder req
 		this.servletContextProvider = servletContextProvider;
 		this.springSecurityOAuth2Provider = springSecurityOAuth2Provider;
 		this.routerFunctionProvider = routerFunctionProvider;
-		this.repositoryRestResourceProvider=repositoryRestResourceProvider;
+		this.repositoryRestResourceProvider = repositoryRestResourceProvider;
 	}
 
 	@Operation(hidden = true)
@@ -123,7 +123,10 @@ public String openapiJson(HttpServletRequest request, @Value(API_DOCS_URL) Strin
 			throws JsonProcessingException {
 		calculateServerUrl(request, apiDocsUrl);
 		OpenAPI openAPI = this.getOpenApi();
-		return Json.mapper().writeValueAsString(openAPI);
+		if (!springDocConfigProperties.isWriterWithDefaultPrettyPrinter())
+			return Json.mapper().writeValueAsString(openAPI);
+		else
+			return Json.mapper().writerWithDefaultPrettyPrinter().writeValueAsString(openAPI);
 	}
 
 	@Operation(hidden = true)
@@ -132,7 +135,10 @@ public String openapiYaml(HttpServletRequest request, @Value(DEFAULT_API_DOCS_UR
 			throws JsonProcessingException {
 		calculateServerUrl(request, apiDocsUrl);
 		OpenAPI openAPI = this.getOpenApi();
-		return Yaml.mapper().writeValueAsString(openAPI);
+		if (!springDocConfigProperties.isWriterWithDefaultPrettyPrinter())
+			return Yaml.mapper().writeValueAsString(openAPI);
+		else
+			return Yaml.mapper().writerWithDefaultPrettyPrinter().writeValueAsString(openAPI);
 	}
 
 	@Override
@@ -157,9 +163,9 @@ protected void getPaths(Map<String, Object> restControllers) {
 		routerFunctionProvider.ifPresent(routerFunctions -> routerFunctions.getWebMvcRouterFunctionPaths()
 				.ifPresent(routerBeans -> routerBeans.forEach(this::getRouterFunctionPaths)));
 
-		if(repositoryRestResourceProvider.isPresent()){
+		if (repositoryRestResourceProvider.isPresent()) {
 			RepositoryRestResourceProvider restResourceProvider = this.repositoryRestResourceProvider.get();
-			List<RouterOperation>  operationList = restResourceProvider.getRouterOperations(openAPIBuilder.getCalculatedOpenAPI());
+			List<RouterOperation> operationList = restResourceProvider.getRouterOperations(openAPIBuilder.getCalculatedOpenAPI());
 			calculatePath(operationList);
 		}
 	}