[feature] create /version endpoint and return api version in all requests as X-BBLVALIDATOR-VERSION

Author: marmoure

pom.xml

@@ -53,6 +53,13 @@
             <version>${micronaut.validation.version}</version>
         </dependency>
 
+        <!-- Micronaut Serde API - Required for @Serdeable annotation -->
+        <dependency>
+            <groupId>io.micronaut.serde</groupId>
+            <artifactId>micronaut-serde-api</artifactId>
+            <version>2.16.2</version>
+        </dependency>
+
         <!-- https://mvnrepository.com/artifact/io.micronaut.serde/micronaut-serde-jackson -->
         <dependency>
             <groupId>io.micronaut.serde</groupId>
@@ -61,13 +68,28 @@
             <scope>runtime</scope>
         </dependency>
 
+        <!-- Integration between Micronaut and Reactor for request middleware -->
+        <dependency>
+            <groupId>io.micronaut.reactor</groupId>
+            <artifactId>micronaut-reactor</artifactId>
+            <version>3.9.1</version>
+        </dependency>
+
         <!-- Logback for logging -->
         <dependency>
             <groupId>ch.qos.logback</groupId>
             <artifactId>logback-classic</artifactId>
             <version>1.5.21</version>
             <scope>runtime</scope>
         </dependency>
+
+        <!-- SnakeYAML for YAML configuration support -->
+        <dependency>
+            <groupId>org.yaml</groupId>
+            <artifactId>snakeyaml</artifactId>
+            <version>2.0</version>
+            <scope>runtime</scope>
+        </dependency>
     </dependencies>
 
     <build>

src/main/java/com/evolvedbinary/bblValidator/controller/VersionController.java

@@ -0,0 +1,24 @@
+package com.evolvedbinary.bblValidator.controller;
+
+import com.evolvedbinary.bblValidator.dto.ApiVersion;
+import io.micronaut.context.annotation.Value;
+import io.micronaut.http.MediaType;
+import io.micronaut.http.annotation.Controller;
+import io.micronaut.http.annotation.Get;
+import io.micronaut.http.annotation.Produces;
+
+@Controller
+public class VersionController {
+
+    private final String version;
+
+    public VersionController(@Value("${api.version}") String version) {
+        this.version = version;
+    }
+
+    @Get("/version")
+    @Produces(MediaType.APPLICATION_JSON)
+    public ApiVersion getVersion() {
+        return new ApiVersion(version);
+    }
+}

src/main/java/com/evolvedbinary/bblValidator/dto/ApiVersion.java

@@ -0,0 +1,24 @@
+package com.evolvedbinary.bblValidator.dto;
+
+import io.micronaut.serde.annotation.Serdeable;
+
+@Serdeable
+public class ApiVersion {
+
+    private String version;
+
+    public ApiVersion() {
+    }
+
+    public ApiVersion(String version) {
+        this.version = version;
+    }
+
+    public String getVersion() {
+        return version;
+    }
+
+    public void setVersion(String version) {
+        this.version = version;
+    }
+}

src/main/java/com/evolvedbinary/bblValidator/filter/ApiVersionFilter.java

@@ -0,0 +1,23 @@
+package com.evolvedbinary.bblValidator.filter;
+
+import io.micronaut.context.annotation.Value;
+import io.micronaut.http.HttpRequest;
+import io.micronaut.http.MutableHttpResponse;
+import io.micronaut.http.annotation.Filter;
+import io.micronaut.http.filter.HttpServerFilter;
+import io.micronaut.http.filter.ServerFilterChain;
+import org.reactivestreams.Publisher;
+import reactor.core.publisher.Flux;
+
+@Filter("/**")
+public class ApiVersionFilter implements HttpServerFilter {
+
+    @Value("${api.version}")
+    private String version;
+
+    @Override
+    public Publisher<MutableHttpResponse<?>> doFilter(HttpRequest<?> request, ServerFilterChain chain) {
+        return Flux.from(chain.proceed(request))
+                .doOnNext(response -> response.header("X-BBLVALIDATOR-VERSION", version));
+    }
+}

src/main/resources/application.yml

@@ -1,5 +1,7 @@
 micronaut:
   application:
-    name: micronaut-mvp
+    name: bbl-validator
   server:
-    port: 8080
+    port: 8080
+api:
+  version: 1.0.0