huge refactoring to add context-path "/api-impl-demo" instead of "/".

fxrobin · fxrobin · commit 3b82de6136da · 2021-03-25T17:50:14.000+01:00
diff --git a/pom.xml b/pom.xml
@@ -4,7 +4,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>fr.fxjavadevblog</groupId>
 	<artifactId>api-impl-demo</artifactId>
-	<version>0.0.7-SNAPSHOT</version>
+	<version>0.0.8-SNAPSHOT</version>
 	<name>API Implementation Demo</name>
 
 	<properties>
@@ -15,7 +15,7 @@
 
 		<quarkus.platform.artifact-id>quarkus-bom</quarkus.platform.artifact-id>
 		<quarkus.platform.group-id>io.quarkus</quarkus.platform.group-id>
-		<quarkus.platform.version>1.12.1.Final</quarkus.platform.version>
+		<quarkus.platform.version>1.12.2.Final</quarkus.platform.version>
 		<quarkus-plugin.version>${quarkus.platform.version}</quarkus-plugin.version>
 		<lombok.version>1.18.14</lombok.version>
 		<commons-lang.version>3.11</commons-lang.version>
diff --git a/src/main/java/fr/fxjavadevblog/aid/api/videogame/VideoGameResource.java b/src/main/java/fr/fxjavadevblog/aid/api/videogame/VideoGameResource.java
@@ -62,12 +62,14 @@
 
 // JAX-RS + OpenAPI annotations 
 
-@Path("/video-games")
+
+@Path(VideoGameResource.PATH)
 @Tag(name="Videogames", description = "Videogame collection")
 @Produces({MediaType.APPLICATION_JSON, SpecificMediaType.APPLICATION_YAML})
 @Slf4j
 public class VideoGameResource
 {    
+	public static final String PATH = "/video-games";
     private static final String VIDEOGAME_ARG = "videogame";
 	@Inject
     VideoGameRepository videoGameRepository;
diff --git a/src/main/java/fr/fxjavadevblog/aid/health/ApplicationHealthCheck.java b/src/main/java/fr/fxjavadevblog/aid/health/ApplicationHealthCheck.java
@@ -30,9 +30,10 @@ public HealthCheck firstApiCheck()
        return () -> HealthCheckResponse.named(ApplicationConfig.APP_NAME + " health check")
     		   .up()
     		   .withData("app_name", ApplicationConfig.APP_NAME)
+    		   .withData("app_tile", ApplicationConfig.APP_TITLE)
     		   .withData("app_version", ApplicationConfig.APP_VERSION)
     		   .withData("api_version", ApplicationConfig.API_VERSION)
-    		   .withData("api_base_uri", ApplicationConfig.API_VERSIONED_BASE_PATH)
+    		   .withData("api_full_path", ApplicationConfig.API_FULL_PATH)
     		   .withData("started_at", ISO_8601_EXTENDED_DATETIME_FORMAT.format(chrono.getStartTime()))
     		   .withData("uptime", chrono.toString())
     		   .build();
diff --git a/src/main/java/fr/fxjavadevblog/aid/metadata/ApplicationConfig.java b/src/main/java/fr/fxjavadevblog/aid/metadata/ApplicationConfig.java
@@ -19,8 +19,8 @@
 // this definition is merged with resources/META-INF/openapi.yml
 
 @OpenAPIDefinition (
-	info = @Info(title = ApplicationConfig.APP_NAME, version = ApplicationConfig.APP_VERSION),
-	servers = @Server(url = ApplicationConfig.APPLICATION_ROOT_VERSIONED ),
+	info = @Info(title = ApplicationConfig.APP_TITLE, version = ApplicationConfig.APP_VERSION),
+	servers = @Server(url = ApplicationConfig.API_FULL_PATH ),
 	components = @Components(
 					responses =	{
 						@APIResponse(name = ApplicationConfig.RESPONSE_API_ERROR, 						
@@ -38,22 +38,23 @@
 )
 
 
-@ApplicationPath(ApplicationConfig.API_VERSIONED_BASE_PATH)
+@ApplicationPath(ApplicationConfig.API_VERSIONED_PATH)
 
 public class ApplicationConfig extends Application {
 	
 	// these constants are used by OpenApi definition and by the response of /health
 	
-	public static final String PATH_DELIM = "/";
 	
-	public static final String APP_NAME = "API for Atari ST Floppy Catalog";
-	public static final String APP_VERSION = "0.0.7";
-	public static final String API_BASE_PATH = "api";
-	public static final String API_VERSION = "v1";
-	public static final String API_VERSIONED_BASE_PATH = PATH_DELIM + API_VERSION + PATH_DELIM + API_BASE_PATH ;
+	public static final String APP_NAME = "api-impl-demo";
+	public static final String APP_TITLE = "API for Atari ST Floppy Catalog";
+	public static final String APP_VERSION = "0.0.8";
 	
-	public static final String APPLICATION_ROOT_VERSIONED = PATH_DELIM + API_VERSION;
+	public static final String ROOT_PATH = "/" + APP_NAME;
 	
+	public static final String API_VERSION = "v1";
+	public static final String API_ENDPOINT_BASEPATH = "api";	
+	public static final String API_VERSIONED_PATH = "/" + API_VERSION + "/" + API_ENDPOINT_BASEPATH;
+	public static final String API_FULL_PATH = ROOT_PATH + API_VERSIONED_PATH;
 	
 	
 	// aliases for OpenApi references via "ref=" annotation attribute.
diff --git a/src/main/java/fr/fxjavadevblog/aid/utils/openapi/OpenApiFilter.java b/src/main/java/fr/fxjavadevblog/aid/utils/openapi/OpenApiFilter.java
@@ -37,7 +37,7 @@ public void filterOpenAPI(OpenAPI openAPI) {
 	for(Entry <String, PathItem> entry : map.entrySet())
 	{
 		String jaxRsPath = entry.getKey();
-		String openApiPath = StringUtils.remove(jaxRsPath, ApplicationConfig.APPLICATION_ROOT_VERSIONED);
+		String openApiPath = StringUtils.remove(jaxRsPath,ApplicationConfig.API_FULL_PATH);
 	    log.info("JAX-RS Path : {} converted to OpenAPI Path : {}", jaxRsPath, openApiPath);	
 	    newMap.put(openApiPath, entry.getValue());
 	}
diff --git a/src/main/resources/META-INF/openapi.yml b/src/main/resources/META-INF/openapi.yml
@@ -20,6 +20,9 @@ tags:
 
 paths:
   /health:
+    servers:
+    - url: /api-impl-demo/v1
+      description: Override base path for all operations with the /health path
     get:
       tags:
       - Health and Metrics
@@ -38,6 +41,9 @@ paths:
           description: There is no monitored API at this address.
             
   /metrics:
+    servers:
+    - url: /api-impl-demo/v1
+      description: Override base path for all operations with the /metrics path
     get:
       tags:
       - Health and Metrics
diff --git a/src/main/resources/META-INF/resources/index.html b/src/main/resources/META-INF/resources/index.html
@@ -6,11 +6,11 @@
 <style>
 @font-face {
 	font-family: 'atari';
-	src: url('/fonts/atari-st.eot');
-	src: url('/fonts/atari-st.eot?#iefix') format('embedded-opentype'),
-		url('/fonts/atari-st.woff2') format('woff2'),
-		url('/fonts/atari-st.woff') format('woff'), url('/fonts/atari-st.ttf')
-		format('truetype');
+	src: url('./fonts/atari-st.eot');
+	src: url('./fonts/atari-st.eot?#iefix') format('embedded-opentype'),
+		 url('./fonts/atari-st.woff2') format('woff2'),
+		 url('./fonts/atari-st.woff') format('woff'), 
+		 url('./fonts/atari-st.ttf') format('truetype');
 	font-weight: normal;
 	font-style: normal;
 }
@@ -23,18 +23,18 @@
 </head>
 <body>
 	<h1>API for Atari ST Floppy Catalog</h1>
-	<img src="/images/floppy-resized.png" alt="floppy disk 3'1/2" />
+	<img src="./images/floppy-resized.png" alt="floppy disk 3'1/2" />
     <p>Welcome to the landing page of the demo API.</p>
     <p>The goal of this application is to demonstrate REST API best pratices.</p>
     <p>This project runs thanks to Quarkus framework and the source code is hosted here : <a href="https://github.com/fxrobin/api-impl-demo">https://github.com/fxrobin/api-impl-demo</a>.</p>
     <hr />
     <p>Just go these links :
     	<ul>
-          <li>OpenAPI UI : <a href="/openapi-ui">/openapi-ui</a>, direct link to the <a href="/v1/openapi">yaml file</a></li>
-          <li>Watch the <a href="/health-ui">/health</a> or get the  <a href="/v1/health">JSON response</a>. </li>
-          <li>Look at the <a href="/v1/metrics">/metrics</a> of the API.</li>
+          <li>OpenAPI UI : <a href="./openapi-ui">/openapi-ui</a>, direct link to the <a href="./v1/openapi">yaml file</a></li>
+          <li>Watch the <a href="./health-ui">/health</a> or get the  <a href="./v1/health">JSON response</a>. </li>
+          <li>Look at the <a href="./v1/metrics">/metrics</a> of the API.</li>
         </ul>
     <p><strong>Enjoy.</strong></p>
-    <img src="/images/busy-bee.png" alt="Atari ST busy bee" /> 
+    <img src="./images/busy-bee.png" alt="Atari ST busy bee" /> 
 </body>
 </html>
diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties
@@ -3,6 +3,8 @@ quarkus.banner.path=banner.txt
 
 #listening on all interfaces
 quarkus.http.host=0.0.0.0
+quarkus.http.root-path=/api-impl-demo
+quarkus.http.non-application-root-path=/api-impl-demo
 
 # CDI 
 quarkus.arc.remove-unused-beans=false
@@ -14,14 +16,14 @@ quarkus.log.category."fr.fxjavadevblog.qjg".level=INFO
 
 
 # health & metrics
-quarkus.smallrye-health.root-path=/v1/health
-quarkus.smallrye-metrics.path=/v1/metrics
+quarkus.smallrye-health.root-path=v1/health
+quarkus.smallrye-metrics.path=v1/metrics
 quarkus.smallrye-health.ui.always-include=true
  
 
 # OpenAPI
-quarkus.smallrye-openapi.path=/v1/openapi
-quarkus.swagger-ui.path=/openapi-ui
+quarkus.smallrye-openapi.path=v1/openapi
+quarkus.swagger-ui.path=openapi-ui
 quarkus.swagger-ui.always-include=true
 quarkus.swagger-ui.operations-sorter=function (a, b) { var order = { "get": "0", "post": "1", "put": "2", "delete": "3" }; return order[a.method].localeCompare(order[b.method]); }
 quarkus.swagger-ui.validator-url=none
diff --git a/src/test/java/fr/fxjavadevblog/aid/api/videogame/VideoGameHttpTest.java b/src/test/java/fr/fxjavadevblog/aid/api/videogame/VideoGameHttpTest.java
@@ -8,6 +8,7 @@
 import org.junit.jupiter.api.Test;
 
 import fr.fxjavadevblog.aid.global.TestApplicationConfig;
+import fr.fxjavadevblog.aid.metadata.ApplicationConfig;
 import io.quarkus.test.common.http.TestHTTPEndpoint;
 import io.quarkus.test.junit.QuarkusTest;
 import io.restassured.specification.RequestSpecification;
@@ -20,14 +21,16 @@
  */
 
 @QuarkusTest
-@TestHTTPEndpoint(VideoGameResource.class) 
+
+
 class VideoGameHttpTest 
 {
 	
 	private RequestSpecification prepareTest() 
 	{
 		return given()
-        	.baseUri(TestApplicationConfig.REST_ASSURED_FULL_BASE_URI)
+			.baseUri(TestApplicationConfig.REST_ASSURED_HTTP_BASE)
+	        .basePath(ApplicationConfig.API_FULL_PATH + VideoGameResource.PATH)
         	.log().uri()
         	.when();
 	}
diff --git a/src/test/java/fr/fxjavadevblog/aid/global/TestApplicationConfig.java b/src/test/java/fr/fxjavadevblog/aid/global/TestApplicationConfig.java
@@ -17,8 +17,8 @@ public class TestApplicationConfig {
 	public static final String  REST_ASSURED_HTTP_BASE = "http://localhost:8081";
 	
 	/**
-	 * full URL to baseApi. Ex: http://localhost:8081/api/v1
+	 * full URL to baseApi. Ex: http://localhost:8081/api-impl-demo/v1/api
 	 */
-	public static final String  REST_ASSURED_FULL_BASE_URI = REST_ASSURED_HTTP_BASE + ApplicationConfig.API_VERSIONED_BASE_PATH;
+	public static final String  REST_ASSURED_FULL_BASE_URI = REST_ASSURED_HTTP_BASE + ApplicationConfig.API_FULL_PATH;
 
 }

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public void filterOpenAPI(OpenAPI openAPI) {`
`37`	`37`	`for(Entry <String, PathItem> entry : map.entrySet())`
`38`	`38`	`{`
`39`	`39`	`String jaxRsPath = entry.getKey();`
`40`		`- String openApiPath = StringUtils.remove(jaxRsPath, ApplicationConfig.APPLICATION_ROOT_VERSIONED);`
	`40`	`+ String openApiPath = StringUtils.remove(jaxRsPath,ApplicationConfig.API_FULL_PATH);`
`41`	`41`	`log.info("JAX-RS Path : {} converted to OpenAPI Path : {}", jaxRsPath, openApiPath);`
`42`	`42`	`newMap.put(openApiPath, entry.getValue());`
`43`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,8 +17,8 @@ public class TestApplicationConfig {`
`17`	`17`	`public static final String REST_ASSURED_HTTP_BASE = "http://localhost:8081";`
`18`	`18`
`19`	`19`	`/**`
`20`		`- * full URL to baseApi. Ex: http://localhost:8081/api/v1`
	`20`	`+ * full URL to baseApi. Ex: http://localhost:8081/api-impl-demo/v1/api`
`21`	`21`	`*/`
`22`		`- public static final String REST_ASSURED_FULL_BASE_URI = REST_ASSURED_HTTP_BASE + ApplicationConfig.API_VERSIONED_BASE_PATH;`
	`22`	`+ public static final String REST_ASSURED_FULL_BASE_URI = REST_ASSURED_HTTP_BASE + ApplicationConfig.API_FULL_PATH;`
`23`	`23`
`24`	`24`	`}`