Add JSON formatting #42

README.md

@@ -68,6 +68,9 @@ It possible to customise the following plugin properties:
     * The default value is: openapi.json
 *   skip: Skip execution if set to true.
     * The default value is: false
+*   format: Formats the json with indentation.
+    * The default value is: false
+    * Should be used with JSON only.
 *   headers: List of headers to send in request
     * The default value is empty
 
@@ -89,6 +92,7 @@ It possible to customise the following plugin properties:
   <outputFileName>openapi.json</outputFileName>
   <outputDir>/home/springdoc/maven-output</outputDir>
   <skip>false</skip>
+  <format>true</format>
   <headers>
     <header1key>header1value</header1key>
     <header2key>header2value</header2key>

pom.xml

@@ -73,6 +73,12 @@
 			<version>3.6.4</version>
 			<scope>provided</scope>
 		</dependency>
+		<dependency>
+			<groupId>org.json</groupId>
+			<artifactId>json</artifactId>
+			<version>20220320</version>
+		</dependency>
+
 	</dependencies>
 
 	<build>

src/main/java/org/springdoc/maven/plugin/SpringDocMojo.java

@@ -19,6 +19,8 @@
 import org.apache.maven.plugins.annotations.ResolutionScope;
 import org.apache.maven.project.MavenProject;
 import org.apache.maven.project.MavenProjectHelper;
+import org.json.JSONObject;
+import org.json.JSONTokener;
 
 /**
  * Generate a openapi specification file.
@@ -80,6 +82,12 @@ public class SpringDocMojo extends AbstractMojo {
 	@Parameter(defaultValue = "false", property = "springdoc.skip")
 	private boolean skip;
 
+	/**
+	 * Formats the openapi.json file if set to true. Default is false.
+	 */
+	@Parameter(defaultValue = "false", property = "springdoc.format")
+	private boolean format;
+
 	/**
 	 * Headers to send in request
 	 */
@@ -110,6 +118,12 @@ public void execute() {
 			int responseCode = connection.getResponseCode();
 			if (responseCode == HttpURLConnection.HTTP_OK) {
 				String result = this.readFullyAsString(connection.getInputStream());
+
+				if (format && outputFileName.endsWith(DEFAULT_OUTPUT_EXTENSION)) {
+					JSONObject object = new JSONObject(new JSONTokener(result));
+					result = object.toString(2);
+				}
+
 				outputDir.mkdirs();
 				Files.write(Paths.get(outputDir.getAbsolutePath() + "/" + outputFileName), result.getBytes(StandardCharsets.UTF_8));
 				if (attachArtifact) addArtifactToMaven();
@@ -123,7 +137,7 @@ public void execute() {
 
 
 	/**
-	 * Read fully as string string.
+	 * Read fully as string.
 	 *
 	 * @param inputStream the input stream
 	 * @return the string