GH-197 Handle default title/version through openapi.info.title/version ap parameters (Resolve #197)

Author: dzikoysk

examples/javalin-gradle-kotlin/build.gradle.kts

@@ -1,3 +1,4 @@
+import org.jetbrains.kotlin.gradle.tasks.Kapt
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 plugins {
@@ -48,6 +49,13 @@ dependencies {
     implementation("org.mongodb:bson:4.9.1")
 }
 
+kapt {
+    arguments {
+        arg("openapi.info.title", "Awesome App")
+        arg("openapi.info.version", "1.0.0")
+    }
+}
+
 repositories {
     mavenCentral()
 }

examples/javalin-gradle-kotlin/src/main/java/io/javalin/openapi/plugin/test/JavalinTest.java

@@ -92,12 +92,10 @@ public static void main(String[] args) {
                             openApiLicense.setName("Apache 2.0");
                             openApiLicense.setIdentifier("Apache-2.0");
 
-                            openApiInfo.setTitle("Awesome App");
                             openApiInfo.setDescription("App description goes right here");
                             openApiInfo.setTermsOfService("https://example.com/tos");
                             openApiInfo.setContact(openApiContact);
                             openApiInfo.setLicense(openApiLicense);
-                            openApiInfo.setVersion("1.0.0");
                         })
                         .withServer((openApiServer) -> {
                             openApiServer.setUrl(("http://localhost:{port}{basePath}/" + version + "/"));

javalin-plugins/javalin-openapi-plugin/src/main/kotlin/io/javalin/openapi/plugin/OpenApiPlugin.kt

@@ -46,7 +46,8 @@ open class OpenApiPlugin @JvmOverloads constructor(private val configuration: Op
         val docsNode = jsonMapper.readTree(content) as ObjectNode
 
         //process OpenAPI "info"
-        docsNode.replace("info", jsonMapper.convertValue(info, JsonNode::class.java))
+        val currentInfo = jsonMapper.readerForUpdating(docsNode.get("info"))
+        docsNode.replace("info", currentInfo.readValue(jsonMapper.convertValue(info, JsonNode::class.java)))
 
         // process OpenAPI "servers"
         docsNode.replace("servers", jsonMapper.convertValue(servers, JsonNode::class.java))

openapi-annotation-processor/src/main/kotlin/io/javalin/openapi/processor/OpenApiAnnotationProcessor.kt

@@ -5,7 +5,11 @@ import io.javalin.openapi.experimental.ExperimentalCompileOpenApiConfiguration
 import io.javalin.openapi.JsonSchema
 import io.javalin.openapi.OpenApi
 import io.javalin.openapi.experimental.AnnotationProcessorContext
+import io.javalin.openapi.experimental.OPENAPI_INFO_TITLE
+import io.javalin.openapi.experimental.OPENAPI_INFO_VERSION
 import io.javalin.openapi.experimental.OpenApiAnnotationProcessorConfiguration
+import io.javalin.openapi.experimental.OpenApiAnnotationProcessorParameters
+import io.javalin.openapi.experimental.OpenApiAnnotationProcessorParameters.Info
 import io.javalin.openapi.processor.configuration.OpenApiPrecompileScriptingEngine
 import io.javalin.openapi.processor.generators.JsonSchemaGenerator
 import io.javalin.openapi.processor.generators.OpenApiGenerator
@@ -24,6 +28,12 @@ open class OpenApiAnnotationProcessor : AbstractProcessor() {
 
     override fun init(processingEnv: ProcessingEnvironment) {
         context = AnnotationProcessorContext(
+            parameters = OpenApiAnnotationProcessorParameters(
+                info = Info(
+                    title = processingEnv.options[OPENAPI_INFO_TITLE] ?: "",
+                    version = processingEnv.options[OPENAPI_INFO_VERSION] ?: ""
+                )
+            ),
             configuration = OpenApiAnnotationProcessorConfiguration(),
             env = processingEnv,
             trees = AnnotationProcessorTools.createTrees(processingEnv)
@@ -54,6 +64,12 @@ open class OpenApiAnnotationProcessor : AbstractProcessor() {
         return true
     }
 
+    override fun getSupportedOptions(): Set<String> =
+        setOf(
+            OPENAPI_INFO_TITLE,
+            OPENAPI_INFO_VERSION,
+        )
+
     override fun getSupportedAnnotationTypes(): Set<String> =
         setOf(
             OpenApi::class.qualifiedName!!,

openapi-annotation-processor/src/main/kotlin/io/javalin/openapi/processor/generators/OpenApiGenerator.kt

@@ -102,8 +102,8 @@ internal class OpenApiGenerator {
 
         // fill info
         val info = JsonObject()
-        info.addProperty("title", "")
-        info.addProperty("version", "")
+        info.addProperty("title", context.parameters.info.title)
+        info.addProperty("version", context.parameters.info.version)
         openApi.add("info", info)
 
         // fill paths

openapi-specification/src/main/kotlin/io/javalin/openapi/experimental/AnnotationProcessorContext.kt

@@ -17,6 +17,7 @@ import javax.lang.model.util.Types
 import kotlin.reflect.KClass
 
 class AnnotationProcessorContext(
+    val parameters: OpenApiAnnotationProcessorParameters,
     val configuration: OpenApiAnnotationProcessorConfiguration,
     val env: ProcessingEnvironment,
     val trees: Trees?,

openapi-specification/src/main/kotlin/io/javalin/openapi/experimental/OpenApiAnnotationProcessorParameters.kt

@@ -0,0 +1,15 @@
+package io.javalin.openapi.experimental
+
+const val OPENAPI_INFO_TITLE = "openapi.info.title"
+const val OPENAPI_INFO_VERSION = "openapi.info.version"
+
+data class OpenApiAnnotationProcessorParameters(
+    val info: Info
+) {
+
+    data class Info(
+        val title: String,
+        val version: String,
+    )
+
+}