Merge pull request #2 from openapi-tools/added-configurable-output-filename

added configurable outputFilename

Author: AllanHoejgaardJensen

src/main/java/io/openapitools/swagger/GenerateMojo.java

@@ -43,6 +43,12 @@ public class GenerateMojo extends AbstractMojo {
     @Parameter(defaultValue = "${project.build.directory}")
     private File outputDirectory;
 
+    /**
+     * Filename to use for the generated documentation.
+     */
+    @Parameter
+    private String outputFilename = "swagger";
+
     /**
      * Choosing the output format. Supports JSON or YAML.
      */
@@ -77,15 +83,16 @@ public void execute() throws MojoExecutionException, MojoFailureException {
             getLog().debug("Created output directory " + outputDirectory);
         }
 
+
         outputFormats.forEach(format -> {
             try {
-                File outputFile = new File(outputDirectory, "swagger." + format.name().toLowerCase());
+                File outputFile = new File(outputDirectory, outputFilename + "." + format.name().toLowerCase());
                 format.write(swagger, outputFile);
                 if (attachSwaggerArtifact) {
                     projectHelper.attachArtifact(project, format.name().toLowerCase(), "swagger", outputFile);
                 }
             } catch (IOException e) {
-                throw new RuntimeException("Unable write Swagger document", e);
+                throw new RuntimeException("Unable write " + outputFilename + " document", e);
             }
         });
     }

src/test/java/io/openapitools/swagger/GenerateMojoIT.java

@@ -73,9 +73,32 @@ public void testGenerateFull() throws Exception {
         Mojo mojo = rule.lookupMojo("generate", new File("src/test/resources/generate-mojo-full-pom.xml"));
         mojo.execute();
 
-        File swaggerJson = new File("target/full/swagger.json");
+        File swaggerJson = new File("target/full/open-api.json");
         assertTrue(swaggerJson.exists());
         assertTrue(swaggerJson.length() > 3000);
+
+        File swaggerYaml = new File("target/full/open-api.yaml");
+        assertTrue(swaggerYaml.exists());
+        assertTrue(swaggerYaml.length() > 3000);
+    }
+
+    @Test
+    public void testGenerateFullNoFileName() throws Exception {
+        Path output = Paths.get("target/semifull");
+        if (Files.exists(output)) {
+            Files.walkFileTree(output, new DeleteVisitor());
+        }
+
+        Mojo mojo = rule.lookupMojo("generate", new File("src/test/resources/generate-mojo-full-nofilename-pom.xml"));
+        mojo.execute();
+
+        File swaggerJson = new File("target/semifull/swagger.json");
+        assertTrue(swaggerJson.exists());
+        assertTrue(swaggerJson.length() > 3000);
+
+        File swaggerYaml = new File("target/semifull/swagger.yaml");
+        assertTrue(swaggerYaml.exists());
+        assertTrue(swaggerYaml.length() > 3000);
     }
 
 

src/test/resources/generate-mojo-full-nofilename-pom.xml

@@ -0,0 +1,51 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>io.openapitools.swagger.test</groupId>
+    <artifactId>mojo-test</artifactId>
+    <packaging>jar</packaging>
+    <version>1.0.0-SNAPSHOT</version>
+    <name>Swagger Generate Maven Mojo</name>
+
+    <dependencies>
+    </dependencies>
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>io.openapitools.swagger</groupId>
+                <artifactId>swagger-maven-plugin</artifactId>
+                <configuration>
+                    <swaggerConfig>
+                        <schemes>http,https</schemes>
+                        <host>services.example.it</host>
+                        <basePath>/base/path</basePath>
+                        <info>
+                            <title>Title</title>
+                            <version>1.0.0</version>
+                            <termsOfService>Terms</termsOfService>
+                            <contact>
+                                <email>[email protected]</email>
+                                <name>My Name</name>
+                                <url>https://google.com</url>
+                            </contact>
+                            <license>
+                                <url>https://license</url>
+                                <name>MIT</name>
+                            </license>
+                        </info>
+                        <descriptionFile>src/test/resources/descriptions.md</descriptionFile>
+                    </swaggerConfig>
+                    <resourcePackages>
+                        <resourcePackage>io.openapitools.swagger.example</resourcePackage>
+                    </resourcePackages>
+                    <outputFormats>
+                        <outputFormat>JSON</outputFormat>
+                        <outputFormat>YAML</outputFormat>
+                    </outputFormats>
+                    <outputDirectory>target/semifull</outputDirectory>
+                    <outputFilename></outputFilename>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+</project>

src/test/resources/generate-mojo-full-pom.xml

@@ -43,6 +43,7 @@
                         <outputFormat>YAML</outputFormat>
                     </outputFormats>
                     <outputDirectory>target/full</outputDirectory>
+                    <outputFilename>open-api</outputFilename>
                 </configuration>
             </plugin>
         </plugins>

src/test/resources/generate-mojo-pom.xml

@@ -23,6 +23,7 @@
                         <outputFormat>YAML</outputFormat>
                     </outputFormats>
                     <outputDirectory>target/api</outputDirectory>
+                    <outputFilename>swagger</outputFilename>
                 </configuration>
             </plugin>
         </plugins>