Merge pull request #359 from avaje/feature/358

#358 Generated openapi.json should contain a servers section with loc…
avaje · Dec 13, 2023 · 1d537be · 1d537be
2 parents 1532418 + 7d419a2
commit 1d537be
Show file tree

Hide file tree

Showing 6 changed files with 43 additions and 13 deletions.
diff --git a/http-generator-core/src/main/java/io/avaje/http/generator/core/openapi/DocContext.java b/http-generator-core/src/main/java/io/avaje/http/generator/core/openapi/DocContext.java
@@ -10,7 +10,6 @@
 import javax.annotation.processing.Messager;
 import javax.annotation.processing.ProcessingEnvironment;
 import javax.lang.model.element.Element;
-import javax.lang.model.element.TypeElement;
 import javax.lang.model.type.TypeMirror;
 import javax.lang.model.util.Elements;
 import javax.tools.Diagnostic;
@@ -32,6 +31,7 @@
 import io.swagger.v3.oas.models.media.Content;
 import io.swagger.v3.oas.models.media.Schema;
 import io.swagger.v3.oas.models.security.SecurityScheme;
+import io.swagger.v3.oas.models.servers.Server;
 import io.swagger.v3.oas.models.tags.Tag;
 
 /** Context for building the OpenAPI documentation. */
@@ -65,10 +65,14 @@ public boolean isOpenApiAvailable() {
   }
 
   private OpenAPI initOpenAPI() {
-
     OpenAPI openAPI = new OpenAPI();
     openAPI.setPaths(new Paths());
 
+    Server server = new Server();
+    server.setUrl("localhost:8080");
+    server.setDescription("local testing");
+    openAPI.addServersItem(server);
+
     Info info = new Info();
     info.setTitle("");
     info.setVersion("");
@@ -110,7 +114,6 @@ void addRequestBody(Operation operation, Schema schema, String mediaType, String
    * Return the OpenAPI adding the paths and schemas.
    */
   private OpenAPI getApiForWriting() {
-
     Paths paths = openAPI.getPaths();
     if (paths == null) {
       paths = new Paths();
@@ -148,30 +151,29 @@ private Tag createTagItem(TagPrism tag) {
 
   public void addTagsDefinition(Element element) {
     final var tags = TagsPrism.getInstanceOn(element);
-    if (tags == null) return;
-
+    if (tags == null) {
+      return;
+    }
     for(var tag : tags.value()){
       openAPI.addTagsItem(createTagItem(tag));
     }
   }
 
   public void addTagDefinition(Element element) {
-
     for (var tag : TagPrism.getAllInstancesOn(element)) {
       openAPI.addTagsItem(createTagItem(tag));
     }
   }
 
   public void addSecurityScheme(Element element) {
-
     this.addSecuritySchemes(SecuritySchemePrism.getAllInstancesOn(element));
   }
 
   public void addSecuritySchemes(Element element) {
     var schemes = SecuritySchemesPrism.getInstanceOn(element);
     if (schemes == null) {
-        return;
-      }
+      return;
+    }
     this.addSecuritySchemes(schemes.value());
   }
 
@@ -196,7 +198,6 @@ void addSecuritySchemes(List<SecuritySchemePrism> schemes) {
   }
 
   public void readApiDefinition(Element element) {
-
     final var openApi = OpenAPIDefinitionPrism.getInstanceOn(element);
     final var info = openApi.info();
     if (!info.title().isEmpty()) {
@@ -217,7 +218,6 @@ public void writeApi() {
 
     } catch (final Exception e) {
       logError(null, "Error writing openapi file" + e.getMessage());
-      e.printStackTrace();
     }
   }
 

diff --git a/tests/test-javalin-jsonb/src/main/resources/public/openapi.json b/tests/test-javalin-jsonb/src/main/resources/public/openapi.json
@@ -5,6 +5,12 @@
 		"description" : "Example Javalin controllers with Java and Maven",
 		"version" : ""
 	},
+	"servers" : [
+		{
+			"url" : "localhost:8080",
+			"description" : "local testing"
+		}
+	],
 	"tags" : [
 		{
 			"name" : "tag1",
@@ -844,7 +850,7 @@
 				],
 				"responses" : {
 					"200" : {
-						"description" : "The Hello DTO given the id and name.",
+						"description" : "Return the Hello DTO.",
 						"content" : {
 							"application/json" : {
 								"schema" : {

diff --git a/tests/test-javalin-jsonb/src/test/resources/expectedInheritedOpenApi.json b/tests/test-javalin-jsonb/src/test/resources/expectedInheritedOpenApi.json
@@ -4,6 +4,12 @@
 		"title" : "Example service showing off the Path extension method of controller",
 		"version" : ""
 	},
+  "servers" : [
+    {
+      "url" : "localhost:8080",
+      "description" : "local testing"
+    }
+  ],
 	"tags" : [
 		{
 			"name" : "tag1",

diff --git a/tests/test-javalin-jsonb/src/test/resources/expectedOpenApi.json b/tests/test-javalin-jsonb/src/test/resources/expectedOpenApi.json
@@ -5,6 +5,12 @@
 		"description" : "Example Javalin controllers with Java and Maven",
 		"version" : ""
 	},
+  "servers" : [
+    {
+      "url" : "localhost:8080",
+      "description" : "local testing"
+    }
+  ],
 	"tags" : [
 		{
 			"name" : "tag1",

diff --git a/tests/test-javalin/src/main/resources/public/openapi.json b/tests/test-javalin/src/main/resources/public/openapi.json
@@ -5,6 +5,12 @@
 		"description" : "Example Javalin controllers with Java and Maven",
 		"version" : ""
 	},
+	"servers" : [
+		{
+			"url" : "localhost:8080",
+			"description" : "local testing"
+		}
+	],
 	"paths" : {
 		"/bars" : {
 			"get" : {
@@ -781,7 +787,7 @@
 				],
 				"responses" : {
 					"200" : {
-						"description" : "The Hello DTO given the id and name.",
+						"description" : "Return the Hello DTO.",
 						"content" : {
 							"application/json" : {
 								"schema" : {

diff --git a/tests/test-jex/src/main/resources/public/openapi.json b/tests/test-jex/src/main/resources/public/openapi.json
@@ -4,6 +4,12 @@
 		"title" : "",
 		"version" : ""
 	},
+	"servers" : [
+		{
+			"url" : "localhost:8080",
+			"description" : "local testing"
+		}
+	],
 	"paths" : {
 		"" : {
 			"get" : {