put server url at interface if requested (#176)

hauner · hauner · commit 759e33ddcaf3 · 2024-09-05T18:53:16.000+02:00
diff --git a/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/ApiOptions.kt b/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/ApiOptions.kt
@@ -91,6 +91,16 @@ class ApiOptions: MappingSettings {
      */
     var jsonPropertyAnnotation = JsonPropertyAnnotationMode.Always
 
+    /**
+     * enable/disable use of server url (optional).
+     */
+    var serverPrefix = false
+
+    /**
+     * index of the server to use as server prefix.
+     */
+    var serverPrefixIndex: Int = 0
+
     /**
      * provide additional type mapping information to map OpenAPI types to java types.
      */
diff --git a/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/framework/AnnotationType.kt b/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/framework/AnnotationType.kt
@@ -0,0 +1,10 @@
+/*
+ * Copyright 2024 https://github.com/openapi-processor/openapi-processor-base
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiprocessor.core.framework
+
+enum class AnnotationType {
+    INTERFACE_PATH_PREFIX
+}
diff --git a/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/framework/FrameworkAnnotations.kt b/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/framework/FrameworkAnnotations.kt
@@ -30,4 +30,12 @@ interface FrameworkAnnotations {
      */
     fun getAnnotation(parameter: Parameter): Annotation
 
+    /**
+     * provides the details of the requested annotation.
+     *
+     * @param type annotation type
+     * @return annotation details
+     */
+
+    fun getAnnotation(type: AnnotationType): Annotation
 }
diff --git a/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/model/Annotation.kt b/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/model/Annotation.kt
@@ -6,6 +6,7 @@
 package io.openapiprocessor.core.model
 
 import io.openapiprocessor.core.converter.mapping.ParameterValue
+import io.openapiprocessor.core.converter.mapping.SimpleParameterValue
 
 open class Annotation(
     private val canonicalName: String,
@@ -35,4 +36,18 @@ open class Annotation(
      */
     val annotationName: String
         get() = "@${typeName}"
+
+    fun withParameter(parameter: String): Annotation {
+        val newParameters = linkedMapOf<String, ParameterValue>()
+        newParameters.putAll(parameters)
+        newParameters[""] = SimpleParameterValue(parameter)
+        return Annotation(canonicalName, newParameters)
+    }
+
+    fun withParameter(key: String, parameter: ParameterValue): Annotation {
+        val m = linkedMapOf<String, ParameterValue>()
+        m.putAll(parameters)
+        m[key] = parameter
+        return Annotation(canonicalName, m)
+    }
 }
diff --git a/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/model/Interface.kt b/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/model/Interface.kt
@@ -14,7 +14,8 @@ import io.openapiprocessor.core.writer.Identifier
 class Interface(
     val name: String,
     private val pkg: String,
-    private val identifier: Identifier
+    private val identifier: Identifier,
+    val path: String? = null
 ) {
     val endpoints: List<Endpoint> = mutableListOf()
 
@@ -38,6 +39,10 @@ class Interface(
         endpoints.addAll(endpoint)
     }
 
+    fun hasPath(): Boolean {
+        return path != null
+    }
+
     override fun toString(): String {
         return "$pkg.$name"
     }
diff --git a/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/InterfaceWriter.kt b/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/InterfaceWriter.kt
@@ -8,7 +8,9 @@ package io.openapiprocessor.core.writer.java
 import io.openapiprocessor.core.converter.ApiOptions
 import io.openapiprocessor.core.converter.MappingFinder
 import io.openapiprocessor.core.converter.MappingQuery
+import io.openapiprocessor.core.framework.AnnotationType
 import io.openapiprocessor.core.framework.FrameworkAnnotations
+import io.openapiprocessor.core.model.Annotation
 import io.openapiprocessor.core.model.Endpoint
 import io.openapiprocessor.core.model.EndpointResponse
 import io.openapiprocessor.core.model.Interface
@@ -25,18 +27,25 @@ class InterfaceWriter(
     private val methodWriter: MethodWriter,
     private val annotations: FrameworkAnnotations,
     private val validationAnnotations: BeanValidationFactory = BeanValidationFactory(apiOptions),
-    private val importFilter: ImportFilter = DefaultImportFilter()
+    private val importFilter: ImportFilter = DefaultImportFilter(),
 ) {
+    private val annotationWriter: AnnotationWriter = AnnotationWriter()
+
     fun write(target: Writer, itf: Interface) {
         target.write ("package ${itf.getPackageName()};\n\n")
 
-        val imports: List<String> = collectImports (itf.getPackageName(), itf.endpoints)
+        val imports: List<String> = collectImports (itf, itf.getPackageName(), itf.endpoints)
         imports.forEach {
             target.write("import ${it};\n")
         }
         target.write("\n")
 
         generatedWriter.writeUse(target)
+
+        if (apiOptions.serverPrefix && itf.hasPath()) {
+            annotationWriter.write(target, getPrefixAnnotation(itf.path))
+            target.write("\n")
+        }
         target.write("public interface ${itf.getInterfaceName()} {\n\n")
 
         itf.endpoints.forEach { ep ->
@@ -49,7 +58,7 @@ class InterfaceWriter(
         target.write ("}\n")
     }
 
-    private fun collectImports(packageName: String, endpoints: List<Endpoint>): List<String> {
+    private fun collectImports(itf: Interface, packageName: String, endpoints: List<Endpoint>): List<String> {
         val imports: MutableSet<String> = mutableSetOf()
 
         imports.addAll(generatedWriter.getImports())
@@ -59,6 +68,10 @@ class InterfaceWriter(
             imports.addAll(annotation.imports)
             imports.addAll(annotation.referencedImports)
 
+            if (apiOptions.serverPrefix && itf.hasPath()) {
+                imports.addAll(getPrefixAnnotation().imports)
+            }
+
             if (ep.deprecated) {
                 imports.add (java.lang.Deprecated::class.java.canonicalName)
             }
@@ -135,4 +148,13 @@ class InterfaceWriter(
             imports.addAll(responseImports)
         }
     }
+
+    private fun getPrefixAnnotation(path: String? = null): Annotation {
+        val annotation = annotations.getAnnotation(AnnotationType.INTERFACE_PATH_PREFIX)
+        return if (path == null) {
+            annotation
+        } else {
+            annotation.withParameter(""""$path"""")
+        }
+    }
 }
diff --git a/openapi-processor-core/src/test/groovy/io/openapiprocessor/core/writer/java/InterfaceWriterGSpec.groovy b/openapi-processor-core/src/test/groovy/io/openapiprocessor/core/writer/java/InterfaceWriterGSpec.groovy
@@ -28,7 +28,7 @@ class InterfaceWriterGSpec extends Specification {
 
     void "writes 'package'" () {
         def pkg = 'com.github.hauner.openapi'
-        def apiItf = new Interface ("", pkg, identifier)
+        def apiItf = new Interface ("", pkg, identifier, null)
 
         when:
         writer.write (target, apiItf)
@@ -42,7 +42,7 @@ package $pkg;
     }
 
     void "writes @Generated import" () {
-        def apiItf = new Interface ("", "", identifier)
+        def apiItf = new Interface ("", "", identifier, null)
 
         when:
         writer.write (target, apiItf)
@@ -54,7 +54,7 @@ import io.openapiprocessor.generated.support.Generated;
     }
 
     void "writes 'interface' block" () {
-        def apiItf = new Interface ('name', 'pkg', identifier)
+        def apiItf = new Interface ('name', 'pkg', identifier, null)
 
         when:
         writer.write (target, apiItf)
diff --git a/openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/builder/api/InterfaceBuilder.kt b/openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/builder/api/InterfaceBuilder.kt
@@ -16,6 +16,7 @@ fun `interface`(
     name: String = "Foo",
     pkg: String = "io.openapiprocessor.test",
     identifier: Identifier = JavaIdentifier(),
+    path: String? = null,
     init: InterfaceBuilder.() -> Unit
 ): Interface {
     val builder = InterfaceBuilder(name, pkg, identifier)
@@ -27,17 +28,19 @@ fun itf(
     name: String = "Foo",
     pkg: String = "io.openapiprocessor.test",
     identifier: Identifier = JavaIdentifier(),
+    path: String? = null,
     init: InterfaceBuilder.() -> Unit
 ): Interface {
-    val builder = InterfaceBuilder(name, pkg, identifier)
+    val builder = InterfaceBuilder(name, pkg, identifier, path)
     init(builder)
     return builder.build()
 }
 
 class InterfaceBuilder(
     private val name: String,
     private val pkg: String,
-    private val identifier: Identifier
+    private val identifier: Identifier,
+    private val path: String? = null
 ) {
     private val endpoints = mutableListOf<Endpoint>()
 
@@ -46,7 +49,7 @@ class InterfaceBuilder(
     }
 
     fun build(): Interface {
-        val itf = Interface(name, pkg, identifier)
+        val itf = Interface(name, pkg, identifier, path)
         itf.add(*endpoints.toTypedArray())
         return itf
     }
diff --git a/openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/support/TestFrameworkAnnotations.kt b/openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/support/TestFrameworkAnnotations.kt
@@ -5,13 +5,15 @@
 
 package io.openapiprocessor.core.support
 
+import io.openapiprocessor.core.framework.AnnotationType
 import io.openapiprocessor.core.framework.FrameworkAnnotations
 import io.openapiprocessor.core.model.Annotation
 import io.openapiprocessor.core.model.parameters.Parameter
 import io.openapiprocessor.core.parser.HttpMethod
 
 val MAPPING = Annotation("annotation.Mapping")
 val PARAMETER = Annotation("annotation.Parameter")
+val PREFIX = Annotation("annotation.Prefix")
 
 /**
  * simple [io.openapiprocessor.core.framework.FrameworkAnnotations] implementation for testing.
@@ -25,4 +27,8 @@ class TestFrameworkAnnotations: FrameworkAnnotations {
     override fun getAnnotation(parameter: Parameter): Annotation {
         return PARAMETER
     }
+
+    override fun getAnnotation(type: AnnotationType): Annotation {
+        return PREFIX
+    }
 }
diff --git a/openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/writer/java/InterfaceWriterSpec.kt b/openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/writer/java/InterfaceWriterSpec.kt
@@ -10,13 +10,15 @@ import io.kotest.core.spec.style.StringSpec
 import io.kotest.matchers.collections.shouldContain
 import io.kotest.matchers.collections.shouldNotContain
 import io.kotest.matchers.shouldBe
+import io.kotest.matchers.string.shouldContain
 import io.mockk.every
 import io.openapiprocessor.core.builder.api.`interface`
 import io.openapiprocessor.core.builder.api.itf
 import io.openapiprocessor.core.converter.ApiOptions
 import io.openapiprocessor.core.converter.mapping.SimpleParameterValue
 import io.openapiprocessor.core.extractBody
 import io.openapiprocessor.core.extractImports
+import io.openapiprocessor.core.framework.AnnotationType
 import io.openapiprocessor.core.framework.FrameworkAnnotations
 import io.openapiprocessor.core.model.Annotation
 import io.openapiprocessor.core.model.Endpoint
@@ -478,6 +480,30 @@ class InterfaceWriterSpec: StringSpec({
 
         writer.write(target, itf)
 
-        target.toString().contains("interface FooBar")
+        target.toString() shouldContain "interface FooBar"
+    }
+
+    "write server uri as path prefix" {
+        every { annotations.getAnnotation(any<AnnotationType>()) } returns Annotation("annotation.Prefix")
+
+        val itf = itf("foo-bar", "api", path = "/prefix") {
+            endpoint("/foo") {
+                responses {
+                    status("200") {
+                        response("text/plain", StringDataType())
+                    }
+                }
+            }
+        }
+
+        options.serverPrefix = true
+        writer.write(target, itf)
+
+        target.toString() shouldContain "import annotation.Prefix;"
+
+        target.toString() shouldContain """
+            |@Prefix("/prefix")
+            |public interface FooBarApi"""
+            .trimMargin()
     }
 })
diff --git a/openapi-processor-core/src/testInt/kotlin/io/openapiprocessor/core/TestFrameworkAnnotations.kt b/openapi-processor-core/src/testInt/kotlin/io/openapiprocessor/core/TestFrameworkAnnotations.kt
@@ -5,13 +5,15 @@
 
 package io.openapiprocessor.core
 
+import io.openapiprocessor.core.framework.AnnotationType
 import io.openapiprocessor.core.framework.FrameworkAnnotations
 import io.openapiprocessor.core.model.Annotation
 import io.openapiprocessor.core.model.parameters.Parameter
 import io.openapiprocessor.core.parser.HttpMethod
 
 val MAPPING = Annotation("annotation.Mapping")
 val PARAMETER = Annotation("annotation.Parameter")
+val PREFIX = Annotation("annotation.Prefix")
 
 /**
  * simple [io.openapiprocessor.core.framework.FrameworkAnnotations] implementation for testing.
@@ -25,4 +27,8 @@ class TestFrameworkAnnotations: FrameworkAnnotations {
     override fun getAnnotation(parameter: Parameter): Annotation {
         return PARAMETER
     }
+
+    override fun getAnnotation(type: AnnotationType): Annotation {
+        return PREFIX
+    }
 }
