added swagger json output and started improving the swagger output

Author: eviltester

challenger/pom.xml

@@ -19,6 +19,16 @@
             <version>${thingifier.version}</version>
         </dependency>
 
+        <dependency>
+            <groupId>io.swagger.core.v3</groupId>
+            <artifactId>swagger-models</artifactId>
+            <version>${swagger-models-version}</version>
+        </dependency>
+        <dependency>
+            <groupId>io.swagger.core.v3</groupId>
+            <artifactId>swagger-core</artifactId>
+            <version>${swagger-models-version}</version>
+        </dependency>
         <!-- https://mvnrepository.com/artifact/com.amazonaws/aws-java-sdk -->
         <!-- experimental cloud storage of challenger sessions -->
         <!-- todo: split into two apps, one aws enabled, one with local persistance only -->

pom.xml

@@ -10,7 +10,7 @@
 
     <properties>
         <thingifier.version>1.5.6-SNAPSHOT</thingifier.version>
-        <swagger-models-version>2.1.4</swagger-models-version>
+        <swagger-models-version>2.2.27</swagger-models-version>
         <gson-version>2.8.6</gson-version>
         <junit.jupiter.version>5.6.2</junit.jupiter.version>
         <maven.compiler.source>15</maven.compiler.source>

thingifier/pom.xml

@@ -65,6 +65,11 @@
           <artifactId>swagger-models</artifactId>
           <version>${swagger-models-version}</version>
       </dependency>
+      <dependency>
+          <groupId>io.swagger.core.v3</groupId>
+          <artifactId>swagger-core</artifactId>
+          <version>${swagger-models-version}</version>
+      </dependency>
       <dependency>
           <groupId>com.google.code.gson</groupId>
           <artifactId>gson</artifactId>

thingifier/src/main/java/uk/co/compendiumdev/thingifier/api/docgen/ApiRoutingDefinition.java

@@ -1,17 +1,21 @@
 package uk.co.compendiumdev.thingifier.api.docgen;
 
 import uk.co.compendiumdev.thingifier.api.response.ResponseHeader;
+import uk.co.compendiumdev.thingifier.core.domain.definitions.EntityDefinition;
 
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.HashMap;
 import java.util.List;
 
 final public class ApiRoutingDefinition {
 
     private List<RoutingDefinition> routings;
+    private HashMap<String, EntityDefinition> objectSchemas;
 
     public ApiRoutingDefinition() {
-        this.routings = new ArrayList<>();
+        routings = new ArrayList<>();
+        objectSchemas = new HashMap<String,EntityDefinition>();
     }
 
     public Collection<RoutingDefinition> definitions() {
@@ -29,4 +33,18 @@ public RoutingDefinition addRouting(final String documentation, final RoutingVer
         routings.add(defn);
         return defn;
     }
+
+    public void addObjectSchema(EntityDefinition entityDefn) {
+        // TODO this should be an object schema rather than entityDefinition
+        // because we don't want it to be editable
+        objectSchemas.put(entityDefn.getName(),entityDefn);
+    }
+
+    public boolean hasObjectSchemaNamed(String aName){
+        return objectSchemas.containsKey(aName);
+    }
+
+    public Collection<EntityDefinition> getObjectSchemas() {
+        return objectSchemas.values();
+    }
 }

thingifier/src/main/java/uk/co/compendiumdev/thingifier/api/docgen/ApiRoutingDefinitionDocGenerator.java

@@ -67,6 +67,8 @@ public ApiRoutingDefinition generate(String apiPathPrefix) {
 
         for (EntityDefinition entityDefn : thingifier.getERmodel().getEntityDefinitions()) {
 
+            defn.addObjectSchema(entityDefn);
+
             String uniqueIdentifier="?";
             String uniqueIdFieldName="fieldName";
 
@@ -97,10 +99,11 @@ public ApiRoutingDefinition generate(String apiPathPrefix) {
             // we should be able to get things e.g. GET project
             defn.addRouting(
                     String.format("return all the instances of %s", entityDefn.getName()),
-                    RoutingVerb.GET, pluralUrl, RoutingStatus.returnedFromCall()).
-                    addPossibleStatus(RoutingStatus.returnValue(
-                                200, String.format("All the %s", entityDefn.getPlural()))).
-                    setAsFilterableFrom(entityDefn);
+                    RoutingVerb.GET, pluralUrl, RoutingStatus.returnedFromCall()
+                ).addPossibleStatus(RoutingStatus.returnValue(
+                                200, String.format("All the %s", entityDefn.getPlural()))
+                ).setAsFilterableFrom(entityDefn)
+                .returnPayload(200, entityDefn.getName());
 
             defn.addRouting(String.format("headers for all the instances of %s", entityDefn.getName()),
                     RoutingVerb.HEAD, pluralUrl, RoutingStatus.returnedFromCall()).

thingifier/src/main/java/uk/co/compendiumdev/thingifier/api/docgen/RoutingDefinition.java

@@ -4,6 +4,7 @@
 import uk.co.compendiumdev.thingifier.core.domain.definitions.EntityDefinition;
 
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
 
 public class RoutingDefinition {
@@ -15,6 +16,7 @@ public class RoutingDefinition {
     private boolean isFilterable;
     private EntityDefinition filterableEntityDefn;
     private List<RoutingStatus> possibleStatusResponses;
+    private HashMap<Integer,String> returnPayload;
 
     public RoutingDefinition(RoutingVerb verb, String url, RoutingStatus routingStatus, ResponseHeader header) {
         this.verb = verb;
@@ -25,9 +27,12 @@ public RoutingDefinition(RoutingVerb verb, String url, RoutingStatus routingStat
         }
         this.routingStatus = routingStatus;
         this.header = header;
-        this.isFilterable=false;
+
+        // defaults
+        isFilterable=false;
         filterableEntityDefn=null;
-        this.possibleStatusResponses= new ArrayList<>();
+        possibleStatusResponses= new ArrayList<>();
+        returnPayload=new HashMap<Integer, String>();
     }
 
     private List<RoutingStatus> getDefaultPossibleStatusResponses() {
@@ -78,9 +83,10 @@ public boolean isFilterable() {
         return isFilterable;
     }
 
-    public void setAsFilterableFrom(final EntityDefinition definition) {
+    public RoutingDefinition setAsFilterableFrom(final EntityDefinition definition) {
         isFilterable=true;
         filterableEntityDefn = definition;
+        return this;
     }
 
     public EntityDefinition getFilterableEntity() {
@@ -106,4 +112,17 @@ public RoutingDefinition addPossibleStatuses(final Integer... statusCodes) {
         }
         return this;
     }
+
+    public RoutingDefinition returnPayload(final Integer statusCode, String objectSchemaName) {
+        returnPayload.put(statusCode, objectSchemaName);
+        return this;
+    }
+
+    public boolean hasReturnPayloadFor(final Integer statusCode) {
+        return returnPayload.containsKey(statusCode);
+    }
+
+    public String getReturnPayloadFor(final Integer statusCode) {
+        return returnPayload.get(statusCode);
+    }
 }

thingifier/src/main/java/uk/co/compendiumdev/thingifier/swaggerizer/Swaggerizer.java

@@ -1,11 +1,9 @@
 package uk.co.compendiumdev.thingifier.swaggerizer;
 
-import com.google.gson.GsonBuilder;
-import io.swagger.v3.oas.models.OpenAPI;
-import io.swagger.v3.oas.models.Operation;
-import io.swagger.v3.oas.models.PathItem;
-import io.swagger.v3.oas.models.Paths;
+import io.swagger.v3.core.util.Json31;
+import io.swagger.v3.oas.models.*;
 import io.swagger.v3.oas.models.info.Info;
+import io.swagger.v3.oas.models.media.*;
 import io.swagger.v3.oas.models.responses.ApiResponse;
 import io.swagger.v3.oas.models.responses.ApiResponses;
 import io.swagger.v3.oas.models.servers.Server;
@@ -15,6 +13,8 @@
 import uk.co.compendiumdev.thingifier.api.docgen.ApiRoutingDefinitionDocGenerator;
 import uk.co.compendiumdev.thingifier.api.docgen.RoutingDefinition;
 import uk.co.compendiumdev.thingifier.api.docgen.RoutingStatus;
+import uk.co.compendiumdev.thingifier.core.domain.definitions.EntityDefinition;
+import uk.co.compendiumdev.thingifier.core.domain.definitions.field.definition.Field;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -64,6 +64,26 @@ public OpenAPI swagger(){
 
         List<String> processedAdditionalRoutes = new ArrayList<>();
 
+        Components components = new Components();
+        for(EntityDefinition objectSchemaDefinition : routingDefinitions.getObjectSchemas()){
+
+            ObjectSchema object = new ObjectSchema();
+            object.setDescription(objectSchemaDefinition.getName());
+            object.setTitle(objectSchemaDefinition.getName());
+
+            //object.name(objectSchemaDefinition.getName());
+            for(String propertyName : objectSchemaDefinition.getFieldNames()){
+                Field propertyDefinition = objectSchemaDefinition.getField(propertyName);
+                Schema<String> propertyItem = new Schema<String>();
+                propertyItem.setExample(propertyDefinition.getExamples().get(0));
+                object.addProperties(propertyName, propertyItem);
+            }
+
+            components.addSchemas(objectSchemaDefinition.getName(), object);
+        }
+
+        api.components(components);
+
         if(routes!=null) {
 
             api.setPaths(new Paths());
@@ -98,10 +118,25 @@ public OpenAPI swagger(){
                                 final ApiResponses responses = new ApiResponses();
                                 final List<RoutingStatus> possibleStatusResponses = subroute.getPossibleStatusReponses();
                                 for(RoutingStatus possibleStatus : possibleStatusResponses){
+
+                                    ApiResponse response = new ApiResponse().description(
+                                            possibleStatus.description()
+                                    );
+                                    if(route.hasReturnPayloadFor(possibleStatus.value())){
+                                        if(routingDefinitions.hasObjectSchemaNamed(route.getReturnPayloadFor(possibleStatus.value()))){
+                                            String ref = "#/components/schemas/" + route.getReturnPayloadFor(possibleStatus.value());
+
+                                            Schema<String> object = new Schema<>();
+                                            MediaType schema = new MediaType();
+                                            schema.setSchema(object);
+                                            object.set$ref(ref);
+                                            response.setContent(
+                                                    new Content().addMediaType("application/json", schema));
+                                        }
+                                    }
                                     responses.addApiResponse(
-                                            String.valueOf(possibleStatus.value()),
-                                            new ApiResponse().description(
-                                                    possibleStatus.description())
+                                        String.valueOf(possibleStatus.value()),
+                                        response
                                     );
                                 }
                                 if(possibleStatusResponses.size()>0){
@@ -147,7 +182,6 @@ public String asJson(){
         if(api==null){
             swagger();
         }
-        return new GsonBuilder().setPrettyPrinting().
-                create().toJson(api);
+        return Json31.pretty(api);
     }
 }