Nested data classes aren't added as component in openapi output fix #1592

Author: jknack

modules/jooby-openapi/src/main/java/io/jooby/internal/openapi/ParserContext.java

@@ -214,14 +214,26 @@ public Schema schema(Class type) {
       EnumSet.allOf(type).forEach(e -> schema.addEnumItem(((Enum) e).name()));
       return schema;
     }
-    return schemas.computeIfAbsent(type.getName(), k -> {
+    SchemaRef schemaRef = schemas.get(type.getName());
+    if (schemaRef == null) {
       ResolvedSchema resolvedSchema = converters.readAllAsResolvedSchema(type);
       if (resolvedSchema.schema == null) {
         throw new IllegalArgumentException("Unsupported type: " + type);
       }
-      return new SchemaRef(resolvedSchema.schema,
+      schemaRef = new SchemaRef(resolvedSchema.schema,
           RefUtils.constructRef(resolvedSchema.schema.getName()));
-    }).toSchema();
+      schemas.put(type.getName(), schemaRef);
+
+      if (resolvedSchema.referencedSchemas!= null) {
+        for (Map.Entry<String, Schema> e : resolvedSchema.referencedSchemas.entrySet()) {
+          if (!e.getKey().equals(schemaRef.schema.getName())) {
+            SchemaRef dependency = new SchemaRef(e.getValue(), RefUtils.constructRef(e.getValue().getName()));
+            schemas.putIfAbsent(e.getKey(), dependency);
+          }
+        }
+      }
+    }
+    return schemaRef.toSchema();
   }
 
   public Optional<SchemaRef> schemaRef(String type) {

modules/jooby-openapi/src/main/java/io/jooby/internal/openapi/ReturnTypeParser.java

@@ -214,6 +214,22 @@ public static List<String> parse(ParserContext ctx, MethodNode node) {
   }
 
   private static String fromMethodCall(ParserContext ctx, MethodInsnNode node) {
+    if (node.owner.equals(TypeFactory.CONTEXT.getInternalName())) {
+      // handle: return ctx.body(MyType.class)
+      Type[] arguments = Type.getArgumentTypes(node.desc);
+      if (arguments.length == 1 && arguments[0].getClassName().equals(Class.class.getName())) {
+        return InsnSupport.prev(node)
+            .filter(LdcInsnNode.class::isInstance)
+            .findFirst()
+            .map(LdcInsnNode.class::cast)
+            .filter(it -> it.cst instanceof Type)
+            .map(it -> (Type) it.cst)
+            .orElse(TypeFactory.OBJECT)
+            .getClassName()
+            ;
+      }
+      return Object.class.getName();
+    }
     Type returnType = Type.getReturnType(node.desc);
     ClassNode classNode;
     try {

modules/jooby-openapi/src/test/java/examples/FilterApp.java

@@ -15,6 +15,6 @@ public class FilterApp extends Jooby {
 
     });
 
-    get("/api/profile/{id}", ctx -> "profile ID");
+    get("/api/profile/{id}", ctx -> ctx.path("id").value());
   }
 }

modules/jooby-openapi/src/test/java/io/jooby/openapi/OpenAPIYamlTest.java

@@ -510,6 +510,12 @@ public void shouldIncludes(OpenAPIResult result) {
         + "  /api/profile/{id}:\n"
         + "    get:\n"
         + "      operationId: getApiProfileId\n"
+        + "      parameters:\n"
+        + "      - name: id\n"
+        + "        in: path\n"
+        + "        required: true\n"
+        + "        schema:\n"
+        + "          type: string\n"
         + "      responses:\n"
         + "        \"200\":\n"
         + "          description: Success\n"
@@ -540,6 +546,12 @@ public void shouldExcludes(OpenAPIResult result) {
         + "  /api/profile/{id}:\n"
         + "    get:\n"
         + "      operationId: getApiProfileId\n"
+        + "      parameters:\n"
+        + "      - name: id\n"
+        + "        in: path\n"
+        + "        required: true\n"
+        + "        schema:\n"
+        + "          type: string\n"
         + "      responses:\n"
         + "        \"200\":\n"
         + "          description: Success\n"

modules/jooby-openapi/src/test/java/issues/Issue1591.java

@@ -20,7 +20,7 @@ public void shouldParseExampleFromParameters(OpenAPIResult result) {
         + "  /1591:\n"
         + "    get:\n"
         + "      summary: Example.\n"
-        + "      operationId: missingAttributes\n"
+        + "      operationId: parameterExample\n"
         + "      parameters:\n"
         + "      - name: arg1\n"
         + "        in: path\n"
@@ -45,7 +45,9 @@ public void shouldParseExampleFromParameters(OpenAPIResult result) {
         + "          content:\n"
         + "            application/json:\n"
         + "              schema:\n"
-        + "                type: string\n", result.toYaml());
+        + "                type: string\n"
+        + "      security:\n"
+        + "      - basicAuth: []\n", result.toYaml());
   }
 
   @OpenAPITest(App1591b.class)

modules/jooby-openapi/src/test/java/issues/Issue1592.java

@@ -0,0 +1,57 @@
+package issues;
+
+import io.jooby.openapi.OpenAPIResult;
+import io.jooby.openapi.OpenAPITest;
+import issues.i1592.App1592;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+public class Issue1592 {
+
+  @OpenAPITest(value = App1592.class)
+  public void shouldParseNestedTypes(OpenAPIResult result) {
+    assertEquals("openapi: 3.0.1\n"
+        + "info:\n"
+        + "  title: 1592 API\n"
+        + "  description: 1592 API description\n"
+        + "  version: \"1.0\"\n"
+        + "paths:\n"
+        + "  /nested:\n"
+        + "    post:\n"
+        + "      operationId: postNested\n"
+        + "      requestBody:\n"
+        + "        content:\n"
+        + "          application/json:\n"
+        + "            schema:\n"
+        + "              $ref: '#/components/schemas/FairData'\n"
+        + "      responses:\n"
+        + "        \"200\":\n"
+        + "          description: Success\n"
+        + "          content:\n"
+        + "            application/json:\n"
+        + "              schema:\n"
+        + "                $ref: '#/components/schemas/FairData'\n"
+        + "components:\n"
+        + "  schemas:\n"
+        + "    FairEmissionData:\n"
+        + "      type: object\n"
+        + "      properties:\n"
+        + "        co2Emissions:\n"
+        + "          type: array\n"
+        + "          items:\n"
+        + "            type: number\n"
+        + "            format: double\n"
+        + "    FairData:\n"
+        + "      type: object\n"
+        + "      properties:\n"
+        + "        baseYear:\n"
+        + "          type: integer\n"
+        + "          format: int32\n"
+        + "        finalYear:\n"
+        + "          type: integer\n"
+        + "          format: int32\n"
+        + "        annualEmissions:\n"
+        + "          $ref: '#/components/schemas/FairEmissionData'\n", result.toYaml());
+  }
+
+}

modules/jooby-openapi/src/test/java/issues/i1592/App1592.java

@@ -0,0 +1,10 @@
+package issues.i1592;
+
+import io.jooby.Jooby;
+
+public class App1592 extends Jooby {
+
+  {
+    post("/nested", ctx -> ctx.body(FairData.class));
+  }
+}

modules/jooby-openapi/src/test/java/issues/i1592/FairData.java

@@ -0,0 +1,33 @@
+package issues.i1592;
+
+public class FairData {
+  private int baseYear;
+
+  private int finalYear;
+
+  private FairEmissionData annualEmissions;
+
+  public int getBaseYear() {
+    return baseYear;
+  }
+
+  public void setBaseYear(int baseYear) {
+    this.baseYear = baseYear;
+  }
+
+  public int getFinalYear() {
+    return finalYear;
+  }
+
+  public void setFinalYear(int finalYear) {
+    this.finalYear = finalYear;
+  }
+
+  public FairEmissionData getAnnualEmissions() {
+    return annualEmissions;
+  }
+
+  public void setAnnualEmissions(FairEmissionData annualEmissions) {
+    this.annualEmissions = annualEmissions;
+  }
+}

modules/jooby-openapi/src/test/java/issues/i1592/FairEmissionData.java

@@ -0,0 +1,15 @@
+package issues.i1592;
+
+import java.util.List;
+
+public class FairEmissionData {
+  private List<Double> co2Emissions;
+
+  public List<Double> getCo2Emissions() {
+    return co2Emissions;
+  }
+
+  public void setCo2Emissions(List<Double> co2Emissions) {
+    this.co2Emissions = co2Emissions;
+  }
+}