✨ Add a possibility to ignore API starting slash

Added a new generator additional parameter called ignoreEndpointStartingSlash which will ignore a starting slash from a retrofit API PATH definition

Author: vsouhrada

CHANGELOG.md

@@ -1,6 +1,13 @@
 Change Log
 ==========
 
+## 2.0.0 (2020-03-09)
+- Introduced a new config parameter `ignoreEndpointStartingSlash` to ignore endpoint's starting slash in generated 
+Retrofit API service class. See `IgnoreStartingSlashLambda` for more details.
+- Introduced a new lambda `IgnoreStartingSlashLambda` (`{{#lambda.ignoreStartingSlash}}{{paramName}}{{/lambda.ignoreStartingSlash}}`) 
+which removes word *minus* in a fragment if it's in it.
+- For rest of changes see all `2.0.0-xx` changelog messages.
+
 ## 2.0.0-rc03 (2020-02-18)
 
 ### Fixed
@@ -26,7 +33,7 @@ Change Log
 ## 2.0.0-alpha02 (2019-01-21)
 
 ### Added
-- Introduced a new labda `RemoveMinusTextFromNameLambda` (`{{#lambda.removeMinusText}}{{paramName}}{{/lambda.removeMinusText}}`) which removes word *minus* in a fragment if it's in it.
+- Introduced a new lambda `RemoveMinusTextFromNameLambda` (`{{#lambda.removeMinusText}}{{paramName}}{{/lambda.removeMinusText}}`) which removes word *minus* in a fragment if it's in it.
 - New property to remove `minus` word from the header's property name: `additionalProperties["removeMinusTextInHeaderProperty"] = true`. By default `false` will be used.
 
 ### Fixed

README.md

@@ -1,6 +1,6 @@
 # OpenApi 3 Codegen / Swagger
 
-[ ![Download](https://api.bintray.com/packages/emanprague/maven/cz.eman.swagger.codegen/images/download.svg?version=2.0.0-rc01) ](https://bintray.com/emanprague/maven/cz.eman.swagger.codegen/2.0.0-rc03/link)
+[ ![Download](https://api.bintray.com/packages/emanprague/maven/cz.eman.swagger.codegen/images/download.svg?version=2.0.0) ](https://bintray.com/emanprague/maven/cz.eman.swagger.codegen/2.0.0/link)
 
 The Swagger codegen contains a template-driven engine to generate documentation, code for Java, Kotlin and Android such like Retrofit and Room. It is a fork of the https://github.com/OpenAPITools/openapi-generator with modifications
 
@@ -17,7 +17,7 @@ buildscript {
 
     // Kotlin Gradle DSL
     dependencies {
-        classpath("cz.eman.swagger:swagger-codegen:2.0.0-rc03")
+        classpath("cz.eman.swagger:swagger-codegen:2.0.0")
     }
 }
 ```
@@ -53,6 +53,7 @@ configure<SwaggerCodeGenConfig> {
             "generateAliasAsModel" to true,
             "composedArrayAsAny" to true,
             "removeMinusTextInHeaderProperty" to true,
+            "ignoreEndpointStartingSlash" to true,
             "generatePrimitiveTypeAlias" to false,
             "apiPackage" to "cz.mypackage.service",
             "modelPackage" to "cz.mypackage.model"
@@ -89,6 +90,7 @@ configure<SwaggerCodeGenConfig> {
     - `modelPackage` - By this property you can define a package name for your model classes
     - `removeMinusTextInHeaderProperty` - By this property you can enable to generate name of header property without text minus if it is present.
     - `removeOperationParams` - By this property you can remove specific parameters from API operations.
+    - `ignoreEndpointStartingSlash` - By this property you can ignore a starting slash from an endpoint definition if it is present
 
 Other options can be found [here](https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator-maven-plugin/README.md).
 

gradle.properties

@@ -1,3 +1,3 @@
 org.gradle.jvmargs=-Xmx1536m
 
-version=2.0.0-rc03
+version=2.0.0

lib/src/main/kotlin/cz/eman/swagger/codegen/generator/kotlin/KotlinClientCodegen.kt

@@ -3,6 +3,7 @@ package cz.eman.swagger.codegen.generator.kotlin
 import com.google.common.collect.ImmutableMap
 import com.samskivert.mustache.Mustache
 import cz.eman.swagger.codegen.language.*
+import cz.eman.swagger.codegen.templating.mustache.IgnoreStartingSlashLambda
 import cz.eman.swagger.codegen.templating.mustache.RemoveMinusTextFromNameLambda
 import io.swagger.v3.oas.models.media.*
 import org.openapitools.codegen.*
@@ -31,6 +32,7 @@ import java.io.File
  * - `generatePrimitiveTypeAlias` - By this property aliases to primitive are also generated.
  * - `removeMinusTextInHeaderProperty` - By this property you can enable to generate name of header property without text minus if it is present.
  * - `removeOperationParams` - By this property you can remove specific parameters from API operations.
+ * - `ignoreEndpointStartingSlash` - By this property you can ignore a starting slash from an endpoint definition if it is present.
  *
  * @author eMan s.r.o. ([email protected])
  * @author eMan s.r.o. ([email protected])
@@ -63,6 +65,10 @@ open class KotlinClientCodegen : org.openapitools.codegen.languages.KotlinClient
         REMOVE_MINUS_WORD_FROM_PROPERTY(REMOVE_MINUS_TEXT_FROM_HEADER)
     }
 
+    enum class EndpointsCommands constructor(val value: String) {
+        INGORE_ENDPOINT_STARTING_SLASH(REMOVE_ENDPOINT_STARTING_SLASH)
+    }
+
     /**
      * Constructs an instance of `KotlinClientCodegen`.
      */
@@ -78,6 +84,7 @@ open class KotlinClientCodegen : org.openapitools.codegen.languages.KotlinClient
     override fun addMustacheLambdas(): ImmutableMap.Builder<String, Mustache.Lambda> {
         val lambdas = super.addMustacheLambdas()
         lambdas.put(RemoveMinusTextFromNameLambda.LAMBDA_NAME, RemoveMinusTextFromNameLambda(this))
+        lambdas.put(IgnoreStartingSlashLambda.LAMBDA_NAME, IgnoreStartingSlashLambda(this))
 
         return lambdas
     }
@@ -174,8 +181,8 @@ open class KotlinClientCodegen : org.openapitools.codegen.languages.KotlinClient
      */
     @Suppress("UNCHECKED_CAST")
     override fun postProcessOperationsWithModels(
-        objs: MutableMap<String?, Any?>,
-        allModels: List<Any?>?
+            objs: MutableMap<String?, Any?>,
+            allModels: List<Any?>?
     ): Map<String, Any>? {
         super.postProcessOperationsWithModels(objs, allModels)
         val operations = objs["operations"] as? Map<String, Any>?
@@ -267,7 +274,10 @@ open class KotlinClientCodegen : org.openapitools.codegen.languages.KotlinClient
         val infraOptions = HashMap<String, String>()
         infraOptions[GenerateApiType.INFRASTRUCTURE.value] = "Generate Infrastructure API"
         infraOptions[GenerateApiType.API.value] = "Generate API"
+        infraOptions[EndpointsCommands.INGORE_ENDPOINT_STARTING_SLASH.value] =
+                REMOVE_ENDPOINT_STARTING_SLASH_DESCRIPTION
         infrastructureCli.enum = infraOptions
+
         cliOptions.add(infrastructureCli)
     }
 
@@ -280,7 +290,7 @@ open class KotlinClientCodegen : org.openapitools.codegen.languages.KotlinClient
         val headersCli = CliOption(HEADER_CLI, HEADER_CLI_DESCRIPTION)
         val headersOptions = HashMap<String, String>()
         headersOptions[HeadersCommands.REMOVE_MINUS_WORD_FROM_PROPERTY.value] =
-            REMOVE_MINUS_TEXT_FROM_HEADER_DESCRIPTION
+                REMOVE_MINUS_TEXT_FROM_HEADER_DESCRIPTION
         headersCli.enum = headersOptions
         cliOptions.add(headersCli)
     }
@@ -293,11 +303,11 @@ open class KotlinClientCodegen : org.openapitools.codegen.languages.KotlinClient
      */
     private fun initSettingsEmptyDataClass() {
         cliOptions.add(
-            CliOption.newBoolean(
-                EMPTY_DATA_CLASS,
-                EMPTY_DATA_CLASS_DESCRIPTION,
-                false
-            )
+                CliOption.newBoolean(
+                        EMPTY_DATA_CLASS,
+                        EMPTY_DATA_CLASS_DESCRIPTION,
+                        false
+                )
         )
     }
 
@@ -308,11 +318,11 @@ open class KotlinClientCodegen : org.openapitools.codegen.languages.KotlinClient
      */
     private fun initSettingsComposedArrayAny() {
         cliOptions.add(
-            CliOption.newBoolean(
-                COMPOSED_ARRAY_ANY,
-                COMPOSED_ARRAY_ANY_DESCRIPTION,
-                true
-            )
+                CliOption.newBoolean(
+                        COMPOSED_ARRAY_ANY,
+                        COMPOSED_ARRAY_ANY_DESCRIPTION,
+                        true
+                )
         )
     }
 
@@ -324,11 +334,11 @@ open class KotlinClientCodegen : org.openapitools.codegen.languages.KotlinClient
      */
     private fun initSettingsGeneratePrimitiveTypeAlias() {
         cliOptions.add(
-            CliOption.newBoolean(
-                GENERATE_PRIMITIVE_TYPE_ALIAS,
-                GENERATE_PRIMITIVE_TYPE_ALIAS_DESCRIPTION,
-                false
-            )
+                CliOption.newBoolean(
+                        GENERATE_PRIMITIVE_TYPE_ALIAS,
+                        GENERATE_PRIMITIVE_TYPE_ALIAS_DESCRIPTION,
+                        false
+                )
         )
     }
 
@@ -349,9 +359,9 @@ open class KotlinClientCodegen : org.openapitools.codegen.languages.KotlinClient
      */
     private fun addLibraries() {
         supportedLibraries[ROOM] =
-            "Platform: Room v1. JSON processing: Moshi 1.9.2."
+                "Platform: Room v1. JSON processing: Moshi 1.9.2."
         supportedLibraries[ROOM2] =
-            "Platform: Room v2 (androidx). JSON processing: Moshi 1.9.2."
+                "Platform: Room v2 (androidx). JSON processing: Moshi 1.9.2."
 
         val libraryOption = CliOption(CodegenConstants.LIBRARY, "Library template (sub-template) to use")
         libraryOption.enum = supportedLibraries
@@ -447,8 +457,8 @@ open class KotlinClientCodegen : org.openapitools.codegen.languages.KotlinClient
         if (!emptyDataClasses) {
             schema?.let {
                 if (it !is ArraySchema && it !is MapSchema && it !is ComposedSchema
-                    && (it.type == null || it.type.isEmpty())
-                    && (it.properties == null || it.properties.isEmpty())
+                        && (it.type == null || it.type.isEmpty())
+                        && (it.properties == null || it.properties.isEmpty())
                 ) {
                     logger.info("Schema: $name re-typed to \"string\"")
                     it.type = "string"
@@ -523,7 +533,7 @@ open class KotlinClientCodegen : org.openapitools.codegen.languages.KotlinClient
     private fun escapePropertyBaseNameLiteral(modelProperties: List<CodegenProperty>) {
         modelProperties.forEach { property ->
             property.vendorExtensions[VENDOR_EXTENSION_BASE_NAME_LITERAL] =
-                property.baseName.replace("$", "\\$")
+                    property.baseName.replace("$", "\\$")
         }
     }
 

lib/src/main/kotlin/cz/eman/swagger/codegen/language/CodegenConst.kt

@@ -34,4 +34,7 @@ const val REMOVE_OPERATION_PARAMS_DESCRIPTION = "Option to remove specific param
 const val HEADER_CLI = "headerCliOptions"
 const val HEADER_CLI_DESCRIPTION = "Options to generate Header"
 const val REMOVE_MINUS_TEXT_FROM_HEADER = "removeMinusTextInHeaderProperty"
-const val REMOVE_MINUS_TEXT_FROM_HEADER_DESCRIPTION = "Remove minus text from header's property name if it is present."
+const val REMOVE_MINUS_TEXT_FROM_HEADER_DESCRIPTION = "Remove minus text from header's property name if it is present."
+
+const val REMOVE_ENDPOINT_STARTING_SLASH = "ignoreEndpointStartingSlash"
+const val REMOVE_ENDPOINT_STARTING_SLASH_DESCRIPTION = "Remove/Ignore a starting slash from an endpoint definition if it is present."

lib/src/main/kotlin/cz/eman/swagger/codegen/templating/mustache/IgnoreStartingSlashLambda.kt

@@ -0,0 +1,36 @@
+package cz.eman.swagger.codegen.templating.mustache
+
+import com.samskivert.mustache.Mustache
+import com.samskivert.mustache.Template
+import org.openapitools.codegen.CodegenConfig
+import java.io.Writer
+
+/**
+ * A lambda which removes a starting *`/`* in a fragment if it's present.
+ *
+ *
+ * ```mustache
+ * {{#lambda.ignoreStartingSlash}}{{paramName}}{{/lambda.ignoreStartingSlash}}
+ * ```
+ *
+ * For instance if _paramName=/v1/api/nice_ so result will be _v1/api/nice_
+ *
+ * @author eMan s.r.o.
+ * @since 2.0.0
+ * @see[Mustache.Lambda]
+ */
+class IgnoreStartingSlashLambda(private val generator: CodegenConfig) : Mustache.Lambda {
+
+    companion object {
+        const val LAMBDA_NAME = "ignoreStartingSlash"
+    }
+
+    override fun execute(frag: Template.Fragment, out: Writer) {
+        val segmentPath = frag.execute()
+        if (segmentPath.startsWith("/")) {
+            out.write(segmentPath.replaceFirst("/", "", true))
+        } else {
+            out.write(segmentPath)
+        }
+    }
+}

lib/src/main/resources/kotlin-client/libraries/jvm-retrofit2/api.mustache

@@ -39,7 +39,7 @@ interface {{classname}} {
     {{/-first}}
     {{/prioritizedContentTypes}}
     {{/formParams}}
-    @{{httpMethod}}("{{{path}}}")
+    @{{httpMethod}}("{{#ignoreEndpointStartingSlash}}{{#lambda.ignoreStartingSlash}}{{path}}{{/lambda.ignoreStartingSlash}}{{/ignoreEndpointStartingSlash}}{{^ignoreEndpointStartingSlash}}{{path}}{{/ignoreEndpointStartingSlash}}")
     fun {{operationId}}({{^allParams}}){{/allParams}}{{#allParams}}{{>libraries/jvm-retrofit2/queryParams}}{{>libraries/jvm-retrofit2/pathParams}}{{>libraries/jvm-retrofit2/headerParams}}{{>libraries/jvm-retrofit2/bodyParams}}{{>libraries/jvm-retrofit2/formParams}}{{#hasMore}}, {{/hasMore}}{{^hasMore}}){{/hasMore}}{{/allParams}}: Call<{{#isResponseFile}}ResponseBody{{/isResponseFile}}{{^isResponseFile}}{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Unit{{/returnType}}{{/isResponseFile}}>
 
     {{/operation}}