[core][maven][gradle] User-defined server variable substitutions

README.md

@@ -429,7 +429,6 @@ NAME
 SYNOPSIS
         openapi-generator-cli generate
                 [(-a <authorization> | --auth <authorization>)]
-                [--additional-properties <additional properties>...]
                 [--api-package <api package>] [--artifact-id <artifact id>]
                 [--artifact-version <artifact version>]
                 [(-c <configuration file> | --config <configuration file>)]
@@ -450,12 +449,13 @@ SYNOPSIS
                 [--model-name-prefix <model name prefix>]
                 [--model-name-suffix <model name suffix>]
                 [--model-package <model package>]
-                [(-o <output directory> | --output <output directory>)]
+                [(-o <output directory> | --output <output directory>)] 
+                [(-p <additional properties> | --additional-properties <additional properties>)...]
                 [--package-name <package name>] [--release-note <release note>]
                 [--remove-operation-id-prefix]
                 [--reserved-words-mappings <reserved word mappings>...]
-                [(-s | --skip-overwrite)] [--skip-validate-spec]
-                [--strict-spec <true/false strict behavior>]
+                [(-s | --skip-overwrite)] [--server-variables <server variables>...]
+                [--skip-validate-spec] [--strict-spec <true/false strict behavior>]
                 [(-t <template directory> | --template-dir <template directory>)]
                 [--type-mappings <type mappings>...] [(-v | --verbose)]
 

docs/usage.md

@@ -235,7 +235,6 @@ NAME
 SYNOPSIS
         openapi-generator-cli generate
                 [(-a <authorization> | --auth <authorization>)]
-                [--additional-properties <additional properties>...]
                 [--api-package <api package>] [--artifact-id <artifact id>]
                 [--artifact-version <artifact version>]
                 [(-c <configuration file> | --config <configuration file>)]
@@ -256,15 +255,15 @@ SYNOPSIS
                 [--model-name-prefix <model name prefix>]
                 [--model-name-suffix <model name suffix>]
                 [--model-package <model package>]
-                [(-o <output directory> | --output <output directory>)]
+                [(-o <output directory> | --output <output directory>)] 
+                [(-p <additional properties> | --additional-properties <additional properties>)...]
                 [--package-name <package name>] [--release-note <release note>]
                 [--remove-operation-id-prefix]
                 [--reserved-words-mappings <reserved word mappings>...]
-                [(-s | --skip-overwrite)] [--skip-validate-spec]
-                [--strict-spec <true/false strict behavior>]
+                [(-s | --skip-overwrite)] [--server-variables <server variables>...]
+                [--skip-validate-spec] [--strict-spec <true/false strict behavior>]
                 [(-t <template directory> | --template-dir <template directory>)]
                 [--type-mappings <type mappings>...] [(-v | --verbose)]
-
 ```
 
 <details>
@@ -277,19 +276,16 @@ OPTIONS
             remotely. Pass in a URL-encoded string of name:header with a comma
             separating multiple values
 
-        --additional-properties <additional properties>
-            sets additional properties that can be referenced by the mustache
-            templates in the format of name=value,name=value. You can also have
-            multiple occurrences of this option.
-
         --api-package <api package>
             package for generated api classes
 
         --artifact-id <artifact id>
-            artifactId in generated pom.xml
+            artifactId in generated pom.xml. This also becomes part of the
+            generated library's filename
 
         --artifact-version <artifact version>
-            artifact version in generated pom.xml
+            artifact version in generated pom.xml. This also becomes part of the
+            generated library's filename
 
         -c <configuration file>, --config <configuration file>
             Path to configuration file configuration file. It can be json or
@@ -382,6 +378,12 @@ OPTIONS
         -o <output directory>, --output <output directory>
             where to write the generated files (current dir by default)
 
+        -p <additional properties>, --additional-properties <additional
+        properties>
+            sets additional properties that can be referenced by the mustache
+            templates in the format of name=value,name=value. You can also have
+            multiple occurrences of this option.
+
         --package-name <package name>
             package for generated classes (where supported)
 
@@ -400,6 +402,10 @@ OPTIONS
             specifies if the existing files should be overwritten during the
             generation.
 
+        --server-variables <server variables>
+            sets server variables for spec documents which support variable
+            templating of servers.
+
         --skip-validate-spec
             Skips the default behavior of validating an input specification.
 

modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/Generate.java

@@ -18,13 +18,7 @@
 package org.openapitools.codegen.cmd;
 
 import static org.apache.commons.lang3.StringUtils.isNotEmpty;
-import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyAdditionalPropertiesKvpList;
-import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyImportMappingsKvpList;
-import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyInstantiationTypesKvpList;
-import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyLanguageSpecificPrimitivesCsvList;
-import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyReservedWordsMappingsKvpList;
-import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applySystemPropertiesKvpList;
-import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyTypeMappingsKvpList;
+import static org.openapitools.codegen.config.CodegenConfiguratorUtils.*;
 
 import ch.qos.logback.classic.LoggerContext;
 import ch.qos.logback.core.spi.FilterAttachable;
@@ -160,6 +154,12 @@ public class Generate implements Runnable {
                     + " You can also have multiple occurrences of this option.")
     private List<String> importMappings = new ArrayList<>();
 
+    @Option(
+            name = {"--server-variables"},
+            title = "server variables",
+            description = "sets server variables overrides for spec documents which support variable templating of servers.")
+    private List<String> serverVariableOverrides = new ArrayList<>();
+
     @Option(name = {"--invoker-package"}, title = "invoker package",
             description = CodegenConstants.INVOKER_PACKAGE_DESC)
     private String invokerPackage;
@@ -393,6 +393,7 @@ public void run() {
         applyAdditionalPropertiesKvpList(additionalProperties, configurator);
         applyLanguageSpecificPrimitivesCsvList(languageSpecificPrimitives, configurator);
         applyReservedWordsMappingsKvpList(reservedWordsMappings, configurator);
+        applyServerVariablesKvpList(serverVariableOverrides, configurator);
 
         try {
             final ClientOptInput clientOptInput = configurator.toClientOptInput();

modules/openapi-generator-core/src/main/java/org/openapitools/codegen/config/GeneratorSettings.java

@@ -52,6 +52,7 @@ public final class GeneratorSettings implements Serializable {
     private ImmutableMap<String, String> importMappings;
     private ImmutableSet<String> languageSpecificPrimitives;
     private ImmutableMap<String, String> reservedWordMappings;
+    private ImmutableMap<String, String> serverVariables;
 
     private String gitUserId;
     private String gitRepoId;
@@ -245,6 +246,17 @@ public Map<String, String> getReservedWordMappings() {
         return reservedWordMappings;
     }
 
+
+    /**
+     * Gets server variable. Values defined here will be attempted to be replaced within a templated server object.
+     *
+     * @return the server variables
+     */
+    public Map<String, String> getServerVariables() {
+        return serverVariables;
+    }
+
+
     /**
      * Gets git user id. e.g. <strong>openapitools</strong>.
      * <p>
@@ -311,6 +323,7 @@ private GeneratorSettings(Builder builder) {
         importMappings = ImmutableMap.copyOf(builder.importMappings);
         languageSpecificPrimitives = ImmutableSet.copyOf(builder.languageSpecificPrimitives);
         reservedWordMappings = ImmutableMap.copyOf(builder.reservedWordMappings);
+        serverVariables = ImmutableMap.copyOf(builder.serverVariables);
         gitUserId = builder.gitUserId;
         gitRepoId = builder.gitRepoId;
         releaseNote = builder.releaseNote;
@@ -373,6 +386,7 @@ public GeneratorSettings() {
         importMappings = ImmutableMap.of();
         languageSpecificPrimitives = ImmutableSet.of();
         reservedWordMappings = ImmutableMap.of();
+        serverVariables = ImmutableMap.of();
     }
 
     private void setDefaults() {
@@ -394,12 +408,6 @@ public static Builder newBuilder() {
         return new Builder();
     }
 
-    /**
-     * New builder builder.
-     *
-     * @param copy the copy
-     * @return the builder
-     */
     public static Builder newBuilder(GeneratorSettings copy) {
         Builder builder = new Builder();
         builder.generatorName = copy.getGeneratorName();
@@ -419,6 +427,7 @@ public static Builder newBuilder(GeneratorSettings copy) {
         builder.importMappings = new HashMap<>(copy.getImportMappings());
         builder.languageSpecificPrimitives = new HashSet<>(copy.getLanguageSpecificPrimitives());
         builder.reservedWordMappings = new HashMap<>(copy.getReservedWordMappings());
+        builder.serverVariables = new HashMap<>(copy.getServerVariables());
         builder.gitUserId = copy.getGitUserId();
         builder.gitRepoId = copy.getGitRepoId();
         builder.releaseNote = copy.getReleaseNote();
@@ -449,6 +458,7 @@ public static final class Builder {
         private Map<String, String> importMappings;
         private Set<String> languageSpecificPrimitives;
         private Map<String, String> reservedWordMappings;
+        private Map<String, String> serverVariables;
         private String gitUserId;
         private String gitRepoId;
         private String releaseNote;
@@ -464,6 +474,7 @@ public Builder() {
             importMappings = new HashMap<>();
             languageSpecificPrimitives = new HashSet<>();
             reservedWordMappings = new HashMap<>();
+            serverVariables = new HashMap<>();
 
             gitUserId = DEFAULT_GIT_USER_ID;
             gitRepoId = DEFAULT_GIT_REPO_ID;
@@ -617,6 +628,17 @@ public Builder withInstantiationType(String key, String value) {
             return this;
         }
 
+        /**
+         * Sets the {@code serverVariables} and returns a reference to this Builder so that the methods can be chained together.
+         *
+         * @param serverVariables the {@code serverVariables} to set
+         * @return a reference to this Builder
+         */
+        public Builder withServerVariables(Map<String, String> serverVariables) {
+            this.serverVariables = serverVariables;
+            return this;
+        }
+
         /**
          * Sets the {@code typeMappings} and returns a reference to this Builder so that the methods can be chained together.
          *
@@ -731,6 +753,22 @@ public Builder withReservedWordMapping(String key, String value) {
             return this;
         }
 
+
+        /**
+         * Sets a single {@code serverVariables} and returns a reference to this Builder so that the methods can be chained together.
+         *
+         * @param key   A key for some server variable
+         * @param value The value of some server variable to be replaced in a templated server object.
+         * @return a reference to this Builder
+         */
+        public Builder withServerVariable(String key, String value) {
+            if (this.serverVariables == null) {
+                this.serverVariables = new HashMap<>();
+            }
+            this.serverVariables.put(key, value);
+            return this;
+        }
+
         /**
          * Sets the {@code gitUserId} and returns a reference to this Builder so that the methods can be chained together.
          *

modules/openapi-generator-gradle-plugin/build.gradle

@@ -1,6 +1,7 @@
 buildscript {
     ext.kotlin_version = '1.2.61'
     repositories {
+        mavenLocal()
         mavenCentral()
         maven {
             url "https://plugins.gradle.org/m2/"

modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/OpenApiGeneratorPlugin.kt

@@ -99,6 +99,7 @@ class OpenApiGeneratorPlugin : Plugin<Project> {
                     instantiationTypes.set(generate.instantiationTypes)
                     typeMappings.set(generate.typeMappings)
                     additionalProperties.set(generate.additionalProperties)
+                    serverVariables.set(generate.serverVariables)
                     languageSpecificPrimitives.set(generate.languageSpecificPrimitives)
                     importMappings.set(generate.importMappings)
                     invokerPackage.set(generate.invokerPackage)

modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/extensions/OpenApiGeneratorGenerateExtension.kt

@@ -120,6 +120,11 @@ open class OpenApiGeneratorGenerateExtension(project: Project) {
      */
     val additionalProperties = project.objects.property<Map<String, String>>()
 
+    /**
+     * Sets server variable for server URL template substitution, in the format of name=value,name=value.
+     */
+    val serverVariables = project.objects.property<Map<String, String>>()
+
     /**
      * Specifies additional language specific primitive types in the format of type1,type2,type3,type3. For example: String,boolean,Boolean,Double.
      */

modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/tasks/GenerateTask.kt

@@ -155,6 +155,13 @@ open class GenerateTask : DefaultTask() {
     @get:Internal
     val additionalProperties = project.objects.property<Map<String, String>>()
 
+    /**
+     * Sets server variable for server URL template substitution, in the format of name=value,name=value.
+     * You can also have multiple occurrences of this option.
+     */
+    @get:Internal
+    val serverVariables = project.objects.property<Map<String, String>>()
+
     /**
      * Specifies additional language specific primitive types in the format of type1,type2,type3,type3. For example: String,boolean,Boolean,Double.
      */
@@ -573,6 +580,12 @@ open class GenerateTask : DefaultTask() {
                 }
             }
 
+            if (serverVariables.isPresent) {
+                serverVariables.get().forEach { entry ->
+                    configurator.addServerVariable(entry.key, entry.value)
+                }
+            }
+
             if (languageSpecificPrimitives.isPresent) {
                 languageSpecificPrimitives.get().forEach {
                     configurator.addLanguageSpecificPrimitive(it)

modules/openapi-generator-maven-plugin/src/main/java/org/openapitools/codegen/plugin/CodeGenMojo.java

@@ -17,19 +17,8 @@
 
 package org.openapitools.codegen.plugin;
 
-import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyAdditionalPropertiesKvp;
-import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyImportMappingsKvp;
-import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyInstantiationTypesKvp;
-import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyLanguageSpecificPrimitivesCsv;
-import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyTypeMappingsKvp;
-import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyReservedWordsMappingsKvp;
-import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyAdditionalPropertiesKvpList;
-import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyImportMappingsKvpList;
-import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyInstantiationTypesKvpList;
-import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyLanguageSpecificPrimitivesCsvList;
-import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyTypeMappingsKvpList;
-import static org.openapitools.codegen.config.CodegenConfiguratorUtils.applyReservedWordsMappingsKvpList;
 import static org.apache.commons.lang3.StringUtils.isNotEmpty;
+import static org.openapitools.codegen.config.CodegenConfiguratorUtils.*;
 
 import java.io.File;
 import java.util.HashMap;
@@ -289,6 +278,12 @@ public class CodeGenMojo extends AbstractMojo {
     @Parameter(name = "additionalProperties", property = "openapi.generator.maven.plugin.additionalProperties")
     private List<String> additionalProperties;
 
+    /**
+     * A map of server variable overrides for specs that support server URL templating
+     */
+    @Parameter(name = "serverVariableOverrides", property = "openapi.generator.maven.plugin.serverVariableOverrides")
+    private List<String> serverVariables;
+
     /**
      * A map of reserved names and how they should be escaped
      */
@@ -615,6 +610,10 @@ public void execute() throws MojoExecutionException {
                             configurator);
                 }
 
+                if (serverVariables == null && configOptions.containsKey("server-variables")) {
+                    applyServerVariablesKvp(configOptions.get("server-variables").toString(), configurator);
+                }
+
                 // Retained for backwards-compataibility with configOptions -> reserved-words-mappings
                 if (reservedWordsMappings == null && configOptions.containsKey("reserved-words-mappings")) {
                     applyReservedWordsMappingsKvp(configOptions.get("reserved-words-mappings")
@@ -648,6 +647,10 @@ public void execute() throws MojoExecutionException {
                 applyAdditionalPropertiesKvpList(additionalProperties, configurator);
             }
 
+            if (serverVariables != null && (configOptions == null || !configOptions.containsKey("server-variables"))) {
+                applyServerVariablesKvpList(serverVariables, configurator);
+            }
+
             // Apply Reserved Words Mappings
             if (reservedWordsMappings != null && (configOptions == null || !configOptions.containsKey("reserved-words-mappings"))) {
                 applyReservedWordsMappingsKvpList(reservedWordsMappings, configurator);

modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenConfig.java

@@ -43,6 +43,8 @@ public interface CodegenConfig {
 
     Map<String, Object> additionalProperties();
 
+    Map<String, String> serverVariableOverrides();
+
     Map<String, Object> vendorExtensions();
 
     String testPackage();

modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenServerVariable.java

@@ -7,4 +7,5 @@ public class CodegenServerVariable {
     public String defaultValue;
     public String description;
     public List<String> enumValues;
+    public String value;
 }