Feature/19 gateway centralized swagger UI

bill/build.gradle

@@ -13,5 +13,13 @@ dependencies {
     implementation project(':common')
     annotationProcessor project(':common')
 
+//  Spring dependencies
+    implementation 'org.springframework.boot:spring-boot-starter-security'
+    testImplementation 'org.springframework.security:spring-security-test'
+
+//  Eureka Service Registry
+    implementation 'org.springframework.cloud:spring-cloud-starter-netflix-eureka-client:3.1.3'
+
+//  Open Api UI dependency
     implementation 'org.springdoc:springdoc-openapi-ui:1.6.9'
 }

bill/src/main/java/com/tungstun/bill/BillApplication.java

@@ -2,12 +2,14 @@
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.kafka.annotation.EnableKafka;
 
 @SpringBootApplication
 @ComponentScan("com.tungstun")
 @EnableKafka
+@EnableEurekaClient
 public class BillApplication {
     public static void main(String[] args) {
         SpringApplication.run(BillApplication.class, args);

bill/src/main/java/com/tungstun/bill/config/SwaggerConfig.java

@@ -1,27 +1,46 @@
 package com.tungstun.bill.config;
 
-import io.swagger.v3.oas.annotations.OpenAPIDefinition;
-import io.swagger.v3.oas.annotations.info.Contact;
-import io.swagger.v3.oas.annotations.info.Info;
-import io.swagger.v3.oas.annotations.tags.Tag;
-import io.swagger.v3.oas.models.annotations.OpenAPI31;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.SpecVersion;
+import io.swagger.v3.oas.models.info.Contact;
+import io.swagger.v3.oas.models.info.Info;
+import io.swagger.v3.oas.models.security.SecurityScheme;
+import io.swagger.v3.oas.models.servers.Server;
+import io.swagger.v3.oas.models.tags.Tag;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
 
-@OpenAPI31
-@OpenAPIDefinition(
-        info = @Info(
-                title = "bartap Backend Api - Bill",
-                description = "Bill API of the bartap Backend API microservice cluster containing bill functionality",
-                version = "1.0",
-                contact = @Contact(
-                        name = "Tungstun",
-                        url = "https://github.com/tungstun-ict",
-                        email = "[email protected]"
-                )
-        ),
-        tags = {
-                @Tag(name = "Bill", description = "Functionality based around the Bill"),
-                @Tag(name = "Order", description = "Functionality based around the Order and Order History"),
-        }
-)
+@Configuration
 public class SwaggerConfig {
+    @Bean
+    public OpenAPI gatewayOpenApi(@Value("${GATEWAY_URL:}") String gatewayUrl) {
+        OpenAPI openApi = new OpenAPI(SpecVersion.V31)
+                .info(new Info()
+                        .title("bartap Backend Api - Bill")
+                        .description("Bill API of the bartap Backend API microservice cluster containing bill functionality")
+                        .version("1.0")
+                        .contact(new Contact()
+                                .name("Tungstun")
+                                .url("https://github.com/tungstun-ict")
+                                .email("[email protected]")))
+                .addTagsItem(new Tag().name("Bill").description("Functionality based around the Bill"))
+                .addTagsItem(new Tag().name("Order").description("Functionality based around the Order"))
+                .schemaRequirement("Bearer", new SecurityScheme()
+                        .name("Bearer")
+                        .description("Authorization using Bearer JWT")
+                        .type(SecurityScheme.Type.HTTP)
+                        .in(SecurityScheme.In.HEADER)
+                        .scheme("bearer")
+                        .bearerFormat("JWT"));
+
+        if (gatewayUrl != null) {
+            openApi.addServersItem(new Server()
+                    .description("Gateway Url")
+                    .url(gatewayUrl)
+            );
+        }
+
+        return openApi;
+    }
 }

bill/src/main/resources/application-dev.properties

@@ -1,7 +1,8 @@
 #JWT variables
 JWT_SECRET=lets-make-a-bar-application-and-use-this-as-a-session-token-secret
 JWT_ISSUER=bartap-security-service
-
 #Database properties and variables
 JDBC_DATABASE_URL=jdbc:h2:mem:test;MODE=PostgreSQL;DB_CLOSE_DELAY=-1
 DRIVER_CLASS_NAME=org.h2.Driver
+#Gateway url
+GATEWAY_URL=http://localhost:8081${server.servlet.context-path}

bill/src/main/resources/application.properties

@@ -1,5 +1,5 @@
 # Standard configurations
-spring.application.name=bartap-bill
+spring.application.name=bill
 spring.profiles.active=dev
 server.port=8083
 server.servlet.context-path=/api
@@ -15,7 +15,10 @@ spring.datasource.driverClassName=${DRIVER_CLASS_NAME}
 spring.datasource.url=${JDBC_DATABASE_URL}
 spring.datasource.username=${JDBC_DATABASE_USERNAME}
 spring.datasource.password=${JDBC_DATABASE_PASSWORD}
-
 # Kafka
 spring.kafka.bootstrap-servers=${BOOTSTRAP_SERVERS:localhost:9092}
 spring.kafka.consumer.auto-offset-reset=earliest
+# Eureka Registry
+eureka.client.service-url.defaultZone=http://localhost:8761/eureka
+eureka.client.fetch-registry=true
+eureka.client.register-with-eureka=true

build.gradle

@@ -26,24 +26,23 @@ subprojects {
     apply plugin: 'jacoco'
 
     dependencies {
+//      Basic Spring dependencies (used by most)
         implementation 'org.springframework.boot:spring-boot-starter'
         implementation 'org.springframework.boot:spring-boot-starter-web'
-        implementation 'org.springframework.boot:spring-boot-starter-webflux'
-        implementation 'org.springframework.boot:spring-boot-starter-security'
         implementation 'org.springframework.boot:spring-boot-starter-validation'
         implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
-        implementation 'org.hibernate.validator:hibernate-validator:6.1.5.Final'
+        testImplementation 'org.springframework.boot:spring-boot-starter-test'
+        annotationProcessor "org.springframework.boot:spring-boot-configuration-processor"
+
+//      In-memory database for easy local spin up and testing
         implementation 'com.h2database:h2'
-        implementation 'io.swagger.core.v3:swagger-core:2.2.1'
 
+//      Spring Kafka
         implementation 'org.springframework.kafka:spring-kafka'
         implementation 'org.springframework.kafka:spring-kafka-test'
         testImplementation 'org.springframework.kafka:spring-kafka-test'
-
-        testImplementation 'org.springframework.boot:spring-boot-starter-test'
-        testImplementation 'org.springframework.security:spring-security-test'
-        testImplementation 'io.projectreactor:reactor-test'
     }
+
     task prepareKotlinBuildScriptModel {}
     task wrapper {}
 

common/build.gradle

@@ -8,13 +8,21 @@ repositories {
 }
 
 dependencies {
+//  Spring dependencies
     implementation 'org.springframework.boot:spring-boot-starter-web'
     implementation 'org.springframework.boot:spring-boot-starter-security'
+    testImplementation 'org.springframework.security:spring-security-test'
+    annotationProcessor "org.springframework.boot:spring-boot-configuration-processor"
+
+//  auth0
     implementation 'com.auth0:java-jwt:3.19.2'
+
+//  Google dependencies
     implementation 'com.google.code.gson:gson:2.9.0'
     implementation 'com.googlecode.libphonenumber:libphonenumber:8.12.49'
+
+//  Reflections library
     implementation 'org.reflections:reflections:0.10.2'
-    annotationProcessor "org.springframework.boot:spring-boot-configuration-processor"
 }
 
 java {

common/src/main/java/com/tungstun/common/locale/TimeZoneConfig.java

@@ -20,4 +20,8 @@ private void loadTimezoneConfig() {
     public void setTimezone(String timezone) {
         this.timezone = timezone;
     }
+
+    public String getTimezone() {
+        return timezone;
+    }
 }

core/build.gradle

@@ -13,6 +13,14 @@ dependencies {
     implementation project(':common')
     annotationProcessor project(':common')
 
+//  Spring dependencies
+    implementation 'org.springframework.boot:spring-boot-starter-security'
+    testImplementation 'org.springframework.security:spring-security-test'
+
+//  Eureka Service Registry
+    implementation 'org.springframework.cloud:spring-cloud-starter-netflix-eureka-client:3.1.3'
+
+//  Open Api UI dependency
     implementation 'org.springdoc:springdoc-openapi-ui:1.6.9'
 }
 

core/src/main/java/com/tungstun/core/CoreApplication.java

@@ -2,12 +2,14 @@
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.kafka.annotation.EnableKafka;
 
 @SpringBootApplication
 @ComponentScan("com.tungstun")
 @EnableKafka
+@EnableEurekaClient
 public class CoreApplication {
     public static void main(String[] args) {
         SpringApplication.run(CoreApplication.class, args);

core/src/main/java/com/tungstun/core/config/SwaggerConfig.java

@@ -1,27 +1,46 @@
 package com.tungstun.core.config;
 
-import io.swagger.v3.oas.annotations.OpenAPIDefinition;
-import io.swagger.v3.oas.annotations.info.Contact;
-import io.swagger.v3.oas.annotations.info.Info;
-import io.swagger.v3.oas.annotations.tags.Tag;
-import io.swagger.v3.oas.models.annotations.OpenAPI31;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.SpecVersion;
+import io.swagger.v3.oas.models.info.Contact;
+import io.swagger.v3.oas.models.info.Info;
+import io.swagger.v3.oas.models.security.SecurityScheme;
+import io.swagger.v3.oas.models.servers.Server;
+import io.swagger.v3.oas.models.tags.Tag;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
 
-@OpenAPI31
-@OpenAPIDefinition(
-        info = @Info(
-                title = "bartap Backend Api - Core",
-                description = "Core API of the bartap Backend API microservice cluster containing bar and session functionality",
-                version = "1.0",
-                contact = @Contact(
-                        name = "Tungstun",
-                        url = "https://github.com/tungstun-ict",
-                        email = "[email protected]"
-                )
-        ),
-        tags = {
-                @Tag(name = "Bar", description = "Functionality based around the Bar"),
-                @Tag(name = "Session", description = "Functionality based around the Session")
-        }
-)
+@Configuration
 public class SwaggerConfig {
+    @Bean
+    public OpenAPI gatewayOpenApi(@Value("${GATEWAY_URL:}") String gatewayUrl) {
+        OpenAPI openApi = new OpenAPI(SpecVersion.V31)
+                .info(new Info()
+                        .title("bartap Backend Api - Core")
+                        .description("Core API of the bartap Backend API microservice cluster containing bar and session functionality")
+                        .version("1.0")
+                        .contact(new Contact()
+                                .name("Tungstun")
+                                .url("https://github.com/tungstun-ict")
+                                .email("[email protected]")))
+                .addTagsItem(new Tag().name("Bar").description("Functionality based around the Bar"))
+                .addTagsItem(new Tag().name("Session").description("Functionality based around the Session"))
+                .schemaRequirement("Bearer", new SecurityScheme()
+                        .name("Bearer")
+                        .description("Authorization using Bearer JWT")
+                        .type(SecurityScheme.Type.HTTP)
+                        .in(SecurityScheme.In.HEADER)
+                        .scheme("bearer")
+                        .bearerFormat("JWT"));
+
+        if (gatewayUrl != null) {
+            openApi.addServersItem(new Server()
+                    .description("Gateway Url")
+                    .url(gatewayUrl)
+            );
+        }
+
+        return openApi;
+    }
 }

core/src/main/resources/application-dev.properties

@@ -1,7 +1,8 @@
 #JWT variables
 JWT_SECRET=lets-make-a-bar-application-and-use-this-as-a-session-token-secret
 JWT_ISSUER=bartap-security-service
-
 #Database properties and variables
 JDBC_DATABASE_URL=jdbc:h2:mem:test;MODE=PostgreSQL;DB_CLOSE_DELAY=-1
 DRIVER_CLASS_NAME=org.h2.Driver
+#Gateway url
+GATEWAY_URL=http://localhost:8081${server.servlet.context-path}

core/src/main/resources/application.properties

@@ -1,5 +1,5 @@
 # Standard configurations
-spring.application.name=bartap-core
+spring.application.name=core
 spring.profiles.active=dev
 server.port=8082
 server.servlet.context-path=/api
@@ -15,7 +15,10 @@ spring.datasource.driverClassName=${DRIVER_CLASS_NAME}
 spring.datasource.url=${JDBC_DATABASE_URL}
 spring.datasource.username=${JDBC_DATABASE_USERNAME}
 spring.datasource.password=${JDBC_DATABASE_PASSWORD}
-
 # Kafka
 spring.kafka.bootstrap-servers=${BOOTSTRAP_SERVERS:localhost:9092}
-spring.kafka.consumer.auto-offset-reset=earliest
+spring.kafka.consumer.auto-offset-reset=earliest
+# Eureka Registry
+eureka.client.service-url.defaultZone=http://localhost:8761/eureka
+eureka.client.fetch-registry=true
+eureka.client.register-with-eureka=true

eureka-server/build.gradle

@@ -0,0 +1,14 @@
+plugins {
+    id 'java'
+    id 'application'
+}
+
+//project.mainClassName = 'com.tungstun.eurekaserver.EurekaServerApplication'
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation 'org.springframework.cloud:spring-cloud-starter-netflix-eureka-server:3.1.3'
+}

eureka-server/src/main/java/com/tungstun/eurekaserver/EurekaServerApplication.java

@@ -0,0 +1,16 @@
+package com.tungstun.eurekaserver;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;
+
+@SpringBootApplication
+@EnableEurekaServer
+public class EurekaServerApplication {
+
+
+    public static void main(String[] args) {
+        SpringApplication.run(EurekaServerApplication.class, args);
+    }
+
+}

eureka-server/src/main/resources/application.properties

@@ -0,0 +1,5 @@
+spring.application.name=eureka-server
+server.port=8761
+# Eureka
+eureka.client.fetch-registry=false
+eureka.client.register-with-eureka=false

eureka-server/src/test/java/com/tungstun/eurekaserver/EurekaServerApplicationTests.java

@@ -0,0 +1,13 @@
+package com.tungstun.eurekaserver;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.boot.test.context.SpringBootTest;
+
+@SpringBootTest
+class EurekaServerApplicationTests {
+
+    @Test
+    void contextLoads() {
+    }
+
+}