Update application.properties with open api docs path, added shell scripts to Docker

Author: arafkarsh

compile

@@ -11,7 +11,7 @@
 # 5. Start the Service using ./run script and then test it with ./test script
 # After the Successful build and Startup of the Service, It should show the Build No. & Date
 # -------------------------------------------------------------------------------------------
-SERVICE=XYZ-SERVICE
+SERVICE=Mock
 
 echo "---------------------------------------------------------------------------------------"
 echo "Compiling $SERVICE Microservice"
@@ -22,7 +22,7 @@ mvn clean
 # -------------------------------------------------------------------------------------------
 echo "Git Commit Count = "`git rev-list HEAD --count`
 echo "---------------------------------------------------------------------------------------"
-#generateBuildNumber $SERVICE
+generateBuildNumber $SERVICE
 # -------------------------------------------------------------------------------------------
 echo "Build the $SERVICE Microservice : mvn -e package"
 echo "---------------------------------------------------------------------------------------"

pom.xml

@@ -3,11 +3,11 @@
 	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>io.fusion.air</groupId>
-	<artifactId>payments-service</artifactId>
+	<artifactId>mock-service</artifactId>
 	<version>0.1.0</version>
 	<packaging>jar</packaging>
-	<name>paymentsService</name>
-	<description>Payment Microservice</description>
+	<name>microService</name>
+	<description>Microservice Template</description>
 
 	<!-- 
 	<parent>

src/docker/Dockerfile

@@ -13,24 +13,28 @@ FROM metamagic/java:8
 
 LABEL author="Araf Karsh Hamid <araf.karsh@metamagic.in>"
 
-RUN mkdir /Softwares/apps/
-RUN mkdir /Softwares/apps/payments/
-RUN mkdir /Softwares/apps/payments/libs
+RUN mkdir /Softwares/service
+RUN mkdir /Softwares/service/libs
+
+ARG SPRINGBOOT_JAR=*-spring-boot.jar
+ARG MAVEN_JAR=*-?.?.?.jar
 
 # Copy Service (Install)
-COPY --chown=arivu:arivu startService /Softwares/apps/payments/
+# COPY --chown=arivu:arivu startService /Softwares/service/
+
 # SpringBoot Fat Jar
-COPY --chown=arivu:arivu payments-service-0.1.0-spring-boot.jar /Softwares/apps/payments/
+COPY --chown=arivu:arivu ${SPRINGBOOT_JAR} /Softwares/service/
+
 # Maven Thin Jar
-#COPY --chown=arivu:arivu payments-service-0.1.0.jar /Softwares/apps/payments/
-#COPY --chown=arivu:arivu /libs /Softwares/apps/payments/libs/
+#COPY --chown=arivu:arivu ${MAVEN_JAR} /Softwares/service/
+#COPY --chown=arivu:arivu /libs /Softwares/service/libs/
 
 # Change the Mode
-RUN chmod -R 750 /Softwares/apps/payments/*
+RUN chmod -R 750 /Softwares/service/*
 
 # Expose Micro Service Port
 EXPOSE 9090
 
 # Start Micro Service
-#ENTRYPOINT ["java","-jar","/Softwares/apps/payments/payments-service-0.1.0.jar"]
-ENTRYPOINT ["java","-jar","/Softwares/apps/payments/payments-service-0.1.0-spring-boot.jar"]
+#ENTRYPOINT ["java","-jar","/Softwares/service/mock-service-0.1.0.jar"]
+ENTRYPOINT ["java","-jar","/Softwares/service/mock-service-0.1.0-spring-boot.jar"]

src/docker/ORG_NAME

@@ -0,0 +1 @@
+metamagic

src/docker/README.MD

@@ -0,0 +1,23 @@
+# Create Docker Container
+
+## Step 1 - Setting Microservice Name
+
+1. Change the micro service name in the file SERVICE_NAME
+2. Change the Org namme in the file ORG_NAME
+3. Change the EntryPoint in the Dockerfile (Last line - jar file name) 
+
+## Step 2 - Build the image
+
+1. build.sh
+2. securityScan
+
+## Step 3 - Test the image
+
+1. start.sh
+2. docker container ls (it shld display the sevice - mentioned in the SERVICE_NAME) as the output - running since.... 
+3. Check the URL in a Browser
+4. docker logs <container-id> (To Troubleshoot)
+
+## Step 4 - Push the image to Cloud Repo
+
+1. docker push org/image

src/docker/SERVICE_NAME

@@ -0,0 +1 @@
+mock-service

src/docker/build.sh

@@ -1,4 +1,5 @@
 #!/bin/bash
-SERVICE=mock-payment
-echo "docker build --force-rm -f Dockerfile -t metamagic/$SERVICE . "
-docker build --force-rm -f Dockerfile -t metamagic/$SERVICE . 
+ORG=`cat ORG_NAME`
+SERVICE=`cat SERVICE_NAME`
+echo "docker build --force-rm -f Dockerfile -t $ORG/$SERVICE . "
+docker build --force-rm -f Dockerfile -t $ORG/$SERVICE . 

src/docker/securityScan

@@ -1,3 +1,4 @@
 #!/bin/bash
-SERVICE=mock-payment
+SERVICE=`cat SERVICE_NAME`
+echo "Scanning $SERVICE for vulnerabilities"
 docker scan metamagic/$SERVICE

src/docker/shell

@@ -1,2 +1,4 @@
 #!/bin/bash
-docker container run -it metamagic/bdd-order-service
+SERVICE=`cat SERVICE_NAME`
+echo "docker container exec -it $SERVICE bash"
+docker container exec -it $SERVICE bash

src/docker/start

@@ -0,0 +1,5 @@
+#!/bin/bash
+ORG=`cat ORG_NAME`
+SERVICE=`cat SERVICE_NAME`
+echo "docker container run --name $SERVICE -d --rm -p 9010:9090 $ORG/$SERVICE"
+docker container run --name $SERVICE -d --rm -p 9010:9090 $ORG/$SERVICE

src/docker/start.sh

@@ -1,3 +1,3 @@
 #!/bin/bash
 echo "Starting the MicroService"
-java -jar payments-service-0.1.0.jar
+java -jar mock-service-0.1.0.jar

src/docker/startService

@@ -1,4 +1,5 @@
 #!/bin/bash
-SERVICE=mock-payment
+ORG=`cat ORG_NAME`
+SERVICE=`cat SERVICE_NAME`
 echo "docker container stop $SERVICE"
 docker container stop $SERVICE

src/docker/stop.sh src/docker/stop

@@ -19,6 +19,7 @@
 import javax.servlet.MultipartConfigElement;
 
 import io.fusion.air.microservice.server.ServiceConfiguration;
+import io.fusion.air.microservice.server.ServiceHealthController;
 import org.slf4j.Logger;
 import org.springdoc.core.GroupedOpenApi;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -94,7 +95,7 @@ public static void main(String[] args) {
 		// Start the Server
 		start(args);
 
-		// API URL : http://localhost:9090/swagger-ui.html
+		// API URL : http://localhost:9090/servicecname/swagger-ui.html
 	}
 
 	/**
@@ -187,13 +188,15 @@ public GroupedOpenApi appPublicApi() {
 
 	/**
 	 * Open API v3 Docs - Core Service
-	 * @return
+	 * Change the Resource Mapping in ServiceHealthController
+	 *
+	 * @see ServiceHealthController
 	 */
 	@Bean
 	public GroupedOpenApi corePublicApi() {
 		return GroupedOpenApi.builder()
 				.group(serviceName+"-service-core")
-				.pathsToMatch("/api/v1/service/**")
+				.pathsToMatch("/api/v1/"+serviceName.toLowerCase()+"/service/**")
 				.build();
 	}
 

src/main/java/io/fusion/air/microservice/ServiceBootStrap.java

@@ -35,6 +35,9 @@
 		name = "serviceConfig", 
 		value = "classpath:application.properties")
 public class ServiceConfiguration {
+
+	@Value("${springdoc.swagger-ui.path}")
+	private String apiDocPath;
 
 	@Value("${service.name:NameNotDefined}")
 	private String serviceName;
@@ -110,7 +113,7 @@ public ServiceConfiguration(String rHost, int rPort) {
 	 * @return
 	 */
 	public String getAPIURL() {
-		return "http://localhost:"+serverPort+"/swagger-ui.html";
+		return "http://localhost:"+serverPort+"/"+apiDocPath;
 	}
 
 	/**

src/main/java/io/fusion/air/microservice/server/ServiceConfiguration.java

@@ -56,7 +56,7 @@
  */
 @Configuration
 @RestController
-@RequestMapping("/api/v1/service")
+@RequestMapping("/api/v1/payment/service")
 @RequestScope
 @Tag(name = "Core", description = "Core Service (Health, Readiness, ReStart.. etc)")
 public class ServiceHealthController {

src/main/java/io/fusion/air/microservice/server/ServiceHealthController.java

@@ -1,5 +1,5 @@
 # =======================================================================
-#  Service Properties
+# Mock Service Properties
 # =======================================================================
-build.number=1
-build.date=Tue Aug 10 19:29:28 IST 2021
+build.number=6
+build.date=Thu Aug 12 14:15:08 IST 2021

src/main/resources/app.props.build

@@ -1,7 +1,12 @@
 # =======================================================================
-# Micro Service Properties
+# Service Name & API Docs
 # =======================================================================
 service.name=Payment
+springdoc.api-docs.path=/api/v1/payments/docs
+springdoc.swagger-ui.path=/api/v1/payments/swagger-ui.html
+# =======================================================================
+# Micro Service Properties
+# =======================================================================
 server.port=9090
 server.version=0.1.0
 server.restart=true
@@ -26,6 +31,7 @@ remote.protocol=http
 springdoc.api-docs.enabled=true
 # Disabling the swagger-ui
 #springdoc.swagger-ui.enabled=true
+springdoc.swagger-ui.operationsSorter=method
 # Packages to include
 # springdoc.packagesToScan=io.fusion.water, io.fusion.fire
 # Paths to include

src/main/resources/app.props.tmpl

@@ -1,12 +1,17 @@
 # =======================================================================
-#  Service Properties
+# Mock Service Properties
 # =======================================================================
-build.number=1
-build.date=Tue Aug 10 19:29:28 IST 2021
+build.number=6
+build.date=Thu Aug 12 14:15:08 IST 2021
 # =======================================================================
-# Micro Service Properties
+# Service Name & API Docs
 # =======================================================================
 service.name=Payment
+springdoc.api-docs.path=/api/v1/payments/docs
+springdoc.swagger-ui.path=/api/v1/payments/swagger-ui.html
+# =======================================================================
+# Micro Service Properties
+# =======================================================================
 server.port=9090
 server.version=0.1.0
 server.restart=true
@@ -31,6 +36,7 @@ remote.protocol=http
 springdoc.api-docs.enabled=true
 # Disabling the swagger-ui
 #springdoc.swagger-ui.enabled=true
+springdoc.swagger-ui.operationsSorter=method
 # Packages to include
 # springdoc.packagesToScan=io.fusion.water, io.fusion.fire
 # Paths to include