Merge pull request #177 from kevin70/master

OpenAPI documents support enumeration types

Author: rbygrave

http-generator-core/src/main/java/io/avaje/http/generator/core/openapi/OpenAPISerializer.java

@@ -81,7 +81,7 @@ static String serialize(Object obj) throws IllegalAccessException {
               sb.append(",");
             }
             sb.append("\"");
-            sb.append(field.getName());
+            sb.append(field.getName().replace("_enum", "enum"));
             sb.append("\" : ");
             write(sb, value);
             firstField = false;

http-generator-core/src/main/java/io/avaje/http/generator/core/openapi/SchemaDocBuilder.java

@@ -3,6 +3,7 @@
 import static io.avaje.http.generator.core.Util.typeDef;
 
 import io.avaje.http.generator.core.javadoc.Javadoc;
+import io.swagger.v3.oas.models.media.StringSchema;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
@@ -11,6 +12,7 @@
 
 import javax.lang.model.element.AnnotationMirror;
 import javax.lang.model.element.Element;
+import javax.lang.model.element.ElementKind;
 import javax.lang.model.element.Modifier;
 import javax.lang.model.element.TypeElement;
 import javax.lang.model.element.VariableElement;
@@ -149,9 +151,27 @@ Schema<?> toSchema(TypeMirror type) {
     if (types.isAssignable(type, iterableType)) {
       return buildIterableSchema(type);
     }
+    Element e = types.asElement(type);
+    if (e != null && e.getKind() == ElementKind.ENUM) {
+      return buildEnumSchema(e);
+    }
     return buildObjectSchema(type);
   }
 
+  private Schema<?> buildEnumSchema(Element e) {
+    var schema = new StringSchema();
+    e.getEnclosedElements().stream()
+      .filter(ec -> ec.getKind().equals(ElementKind.ENUM_CONSTANT))
+      .forEach(ec -> schema.addEnumItem(ec.getSimpleName().toString()));
+
+    var doc = Javadoc.parse(elements.getDocComment(e));
+    var desc = doc.getDescription();
+    if (desc != null && !desc.isEmpty()) {
+      schema.setDescription(desc);
+    }
+    return schema;
+  }
+
   private Schema<?> buildObjectSchema(TypeMirror type) {
     String objectSchemaKey = getObjectSchemaName(type);
 

tests/test-javalin-jsonb/src/main/resources/public/openapi.json

@@ -1,18 +1,18 @@
 {
 	"openapi" : "3.0.1",
 	"info" : {
-		"title" : "Example service showing off the Path extension method of controller",
+		"title" : "Example service",
 		"description" : "Example Javalin controllers with Java and Maven",
 		"version" : ""
 	},
 	"tags" : [
 		{
 			"name" : "tag1",
-			"description" : "this is added to openapi tags"
+			"description" : "it's somethin"
 		},
 		{
 			"name" : "tag1",
-			"description" : "it's somethin"
+			"description" : "this is added to openapi tags"
 		}
 	],
 	"paths" : {
@@ -1156,7 +1156,12 @@
 										"type" : "string"
 									},
 									"type" : {
-										"$ref" : "#/components/schemas/ServerType"
+										"type" : "string",
+										"enum" : [
+											"PROXY",
+											"HIDE_N_SEEK",
+											"FFA"
+										]
 									}
 								}
 							}
@@ -1195,7 +1200,12 @@
 										"type" : "string"
 									},
 									"type" : {
-										"$ref" : "#/components/schemas/ServerType"
+										"type" : "string",
+										"enum" : [
+											"PROXY",
+											"HIDE_N_SEEK",
+											"FFA"
+										]
 									}
 								}
 							}
@@ -1229,7 +1239,12 @@
 						"name" : "type",
 						"in" : "query",
 						"schema" : {
-							"$ref" : "#/components/schemas/ServerType"
+							"type" : "string",
+							"enum" : [
+								"PROXY",
+								"HIDE_N_SEEK",
+								"FFA"
+							]
 						}
 					}
 				],
@@ -1261,7 +1276,12 @@
 						"schema" : {
 							"type" : "array",
 							"items" : {
-								"$ref" : "#/components/schemas/ServerType"
+								"type" : "string",
+								"enum" : [
+									"PROXY",
+									"HIDE_N_SEEK",
+									"FFA"
+								]
 							}
 						}
 					}
@@ -1299,7 +1319,12 @@
 						"name" : "type",
 						"in" : "query",
 						"schema" : {
-							"$ref" : "#/components/schemas/ServerType"
+							"type" : "string",
+							"enum" : [
+								"PROXY",
+								"HIDE_N_SEEK",
+								"FFA"
+							]
 						}
 					}
 				],
@@ -1903,9 +1928,6 @@
 					}
 				}
 			},
-			"ServerType" : {
-				"type" : "object"
-			},
 			"byte" : {
 				"type" : "object"
 			}

tests/test-jex/src/main/java/org/example/web/HelloDto.java

@@ -8,4 +8,5 @@ public class HelloDto {
   public int id;
   @NotNull
   public String name;
+  public ServerType serverType;
 }

tests/test-jex/src/main/resources/public/openapi.json

@@ -190,7 +190,12 @@
 						"name" : "type",
 						"in" : "query",
 						"schema" : {
-							"$ref" : "#/components/schemas/ServerType"
+							"type" : "string",
+							"enum" : [
+								"PROXY",
+								"HIDE_N_SEEK",
+								"FFA"
+							]
 						}
 					}
 				],
@@ -222,7 +227,12 @@
 						"schema" : {
 							"type" : "array",
 							"items" : {
-								"$ref" : "#/components/schemas/ServerType"
+								"type" : "string",
+								"enum" : [
+									"PROXY",
+									"HIDE_N_SEEK",
+									"FFA"
+								]
 							}
 						}
 					}
@@ -260,7 +270,12 @@
 						"name" : "type",
 						"in" : "query",
 						"schema" : {
-							"$ref" : "#/components/schemas/ServerType"
+							"type" : "string",
+							"enum" : [
+								"PROXY",
+								"HIDE_N_SEEK",
+								"FFA"
+							]
 						}
 					}
 				],
@@ -363,11 +378,16 @@
 					"name" : {
 						"type" : "string",
 						"nullable" : false
+					},
+					"serverType" : {
+						"type" : "string",
+						"enum" : [
+							"PROXY",
+							"HIDE_N_SEEK",
+							"FFA"
+						]
 					}
 				}
-			},
-			"ServerType" : {
-				"type" : "object"
 			}
 		}
 	}