Add version to Swagger Docs.

cosmincloud · Jan 23, 2019 · 53ca11b · 53ca11b
1 parent 635d2be
commit 53ca11b
Show file tree

Hide file tree

Showing 8 changed files with 59 additions and 37 deletions.
diff --git a/.gitignore b/.gitignore
@@ -28,3 +28,5 @@
 /.nb-gradle/
 
 /.data/
+
+src/main/resources/checklister-build.properties
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -73,6 +73,16 @@ tasks.resolve {
     outputPath = "test"
 }
 
+val generateBuildConfigResourceTask by tasks.registering {
+    File("src/main/resources/checklister-build.properties")
+            .printWriter().use { out ->
+                out.println("version=${project.version.toString()}")
+            }
+}
+
+val compileKotlinTask = tasks.named("compileKotlin").get()
+compileKotlinTask.dependsOn(generateBuildConfigResourceTask)
+
 dependencies {
     // Kotlin
     implementation(kotlin("stdlib-jdk8"))
@@ -130,6 +140,4 @@ dependencies {
 
 //    integrationTestCompile("org.seleniumhq.selenium:selenium-java:3.13.0")
 //    integrationTestCompile("org.seleniumhq.selenium:selenium-remote-driver:3.13.0")
-
-    implementation(project("modules:buildconfig"))
 }
diff --git a/modules/buildconfig/build.gradle.kts b/modules/buildconfig/build.gradle.kts
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -1,2 +1 @@
-rootProject.name = "checklister"
-include("modules:buildconfig")
+rootProject.name = "checklister"
diff --git a/src/main/kotlin/cloud/cosmin/checklister/config/SwaggerConfig.kt b/src/main/kotlin/cloud/cosmin/checklister/config/SwaggerConfig.kt
@@ -1,5 +1,6 @@
 package cloud.cosmin.checklister.config
 
+import cloud.cosmin.checklister.service.BuildConfigService
 import org.springframework.context.annotation.Bean
 import org.springframework.context.annotation.Configuration
 import springfox.documentation.builders.ApiInfoBuilder
@@ -14,22 +15,20 @@ import springfox.documentation.swagger2.annotations.EnableSwagger2
 @EnableSwagger2
 class SwaggerConfig {
     @Bean
-    fun checklisterApi(): Docket {
+    fun checklisterApi(buildConfigService: BuildConfigService): Docket {
         return Docket(DocumentationType.SWAGGER_2)
-                .apiInfo(apiInfo())
+                .apiInfo(apiInfo(buildConfigService))
                 .select()
                     .apis(basePackage("cloud.cosmin.checklister.rest"))
                 .build()
     }
 
-    fun apiInfo(): ApiInfo {
-        val appName = this.javaClass.`package`.implementationTitle
-        val version = this.javaClass.`package`.implementationVersion
+    private fun apiInfo(buildConfigService: BuildConfigService): ApiInfo {
         return ApiInfoBuilder()
-                .title("Checklister API")
+                .title("Checklister")
                 .description("A RESTful API for lists.")
                 .contact(Contact("GitHub", "https://github.com/cosmincloud/checklister", null))
-                .version(version)
+                .version(buildConfigService.getVersion())
                 .license("Apache License Version 2.0")
                 .licenseUrl("https://www.apache.org/licenses/LICENSE-2.0")
                 .build()

diff --git a/src/main/kotlin/cloud/cosmin/checklister/rest/IndexController.kt b/src/main/kotlin/cloud/cosmin/checklister/rest/IndexController.kt
@@ -1,25 +1,14 @@
 package cloud.cosmin.checklister.rest
 
+import org.springframework.stereotype.Controller
 import org.springframework.web.bind.annotation.RequestMapping
-import org.springframework.web.bind.annotation.RestController
 import springfox.documentation.annotations.ApiIgnore
-import cloud.cosmin.checklister.BuildConfig
 
-@RestController
+@Controller
 @ApiIgnore
 class IndexController {
-    @RequestMapping(path = arrayOf("/"), produces = arrayOf("text/html"))
+    @RequestMapping(path = arrayOf("/"))
     fun index(): String {
-        val name = BuildConfig.NAME
-        val version = BuildConfig.VERSION
-        return """
-            <html><body>
-            <h1>${name}</h1>
-            <h2>${version}</h2>
-            <p>
-                <a href="swagger-ui.html">API</a>
-            </p>
-            </body></html>
-        """.trimIndent()
+        return "redirect:/swagger-ui.html"
     }
 }
diff --git a/src/main/kotlin/cloud/cosmin/checklister/service/BuildConfigService.kt b/src/main/kotlin/cloud/cosmin/checklister/service/BuildConfigService.kt
@@ -0,0 +1,21 @@
+package cloud.cosmin.checklister.service
+
+import org.springframework.stereotype.Service
+import java.util.*
+
+@Service
+class BuildConfigService {
+    fun getVersion(): String {
+        val stream = javaClass.classLoader
+                .getResourceAsStream("/checklister-build.properties")
+
+        return when(stream) {
+            null -> "null"
+            else -> {
+                val props = Properties()
+                props.load(stream)
+                props.getProperty("version")
+            }
+        }
+    }
+}
diff --git a/src/main/kotlin/cloud/cosmin/checklister/service/eventsink/LoggerEventSink.kt b/src/main/kotlin/cloud/cosmin/checklister/service/eventsink/LoggerEventSink.kt
@@ -0,0 +1,15 @@
+package cloud.cosmin.checklister.service.eventsink
+
+import cloud.cosmin.checklister.service.EventSink
+import cloud.cosmin.checklister.service.ItemEvent
+import org.apache.logging.log4j.LogManager
+import org.springframework.stereotype.Service
+
+@Service
+class LoggerEventSink : EventSink {
+    private val log = LogManager.getLogger(javaClass)
+
+    override fun accept(event: ItemEvent) {
+        log.info("ItemEvent: {}", event)
+    }
+}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -28,3 +28,5 @@
		/.nb-gradle/

		/.data/

		src/main/resources/checklister-build.properties