changed example to objects to address #936

Author: fehguy

modules/swagger-core/src/test/scala/ModelSerializerTest.scala

@@ -68,4 +68,31 @@ class ModelSerializerTest extends FlatSpec with Matchers {
     val schemas = ModelConverters.getInstance().read(classOf[Manufacturers])
     Json.mapper().writeValueAsString(schemas) should be ("""{"Manufacturers":{"properties":{"countries":{"type":"array","uniqueItems":true,"items":{"type":"string"}}}}}""")
   }
+
+  it should "deserialize a model with object example" in {
+    val json = """{
+      "title": "Error",
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32"
+        },
+        "message": {
+          "type": "string"
+        },
+        "fields": {
+          "type": "string"
+        }
+      },
+      "example": {
+        "code": 1,
+        "message": "hello",
+        "fields": "abc"
+      }
+    }"""
+
+    val model = Json.mapper().readValue(json, classOf[ModelImpl])
+    Json.mapper().writeValueAsString(model.getExample()) should be ("""{"code":1,"message":"hello","fields":"abc"}""")
+  }
 }

modules/swagger-models/src/main/java/com/wordnik/swagger/models/ArrayModel.java

@@ -9,7 +9,7 @@ public class ArrayModel extends AbstractModel {
   private String type;
   private String description;
   private Property items;
-  private String example;
+  private Object example;
 
   public ArrayModel () {
     this.type = "array";
@@ -52,10 +52,10 @@ public void setProperties(Map<String, Property> properties) {
     this.properties = properties;
   }
 
-  public String getExample() {
+  public Object getExample() {
     return example;
   }
-  public void setExample(String example) {
+  public void setExample(Object example) {
     this.example = example;
   }
 

modules/swagger-models/src/main/java/com/wordnik/swagger/models/ComposedModel.java

@@ -12,7 +12,7 @@ public class ComposedModel extends AbstractModel {
   private Model child;
   private List<RefModel> interfaces;
   private String description;
-  private String example;
+  private Object example;
 
   public ComposedModel parent(Model model) {
     this.setParent(model);
@@ -41,10 +41,10 @@ public void setProperties(Map<String, Property> properties){
 
   }
 
-  public String getExample() {
+  public Object getExample() {
     return example;
   }
-  public void setExample(String example) {
+  public void setExample(Object example) {
     this.example = example;
   }
 

modules/swagger-models/src/main/java/com/wordnik/swagger/models/Model.java

@@ -11,8 +11,8 @@ public interface Model {
   Map<String, Property> getProperties();
   void setProperties(Map<String, Property> properties);
 
-  String getExample();
-  void setExample(String example);
+  Object getExample();
+  void setExample(Object example);
 
   ExternalDocs getExternalDocs();
 

modules/swagger-models/src/main/java/com/wordnik/swagger/models/ModelImpl.java

@@ -18,7 +18,7 @@ public class ModelImpl extends AbstractModel {
   private Map<String, Property> properties;
   private boolean isSimple = false;
   private String description;
-  private String example;
+  private Object example;
   private Property additionalProperties;
   private String discriminator;
   private Xml xml;
@@ -39,7 +39,7 @@ public ModelImpl property(String key, Property property) {
     this.addProperty(key, property);
     return this;
   }
-  public ModelImpl example(String example) {
+  public ModelImpl example(Object example) {
     this.setExample(example);
     return this;
   }
@@ -158,15 +158,15 @@ public void setProperties(Map<String, Property> properties) {
       }
   }
 
-  public String getExample() {
+  public Object getExample() {
     if(example == null) {
       // TODO: will add logic to construct examples based on payload here
     }
 
     return example;
   }
 
-  public void setExample(String example) {
+  public void setExample(Object example) {
     this.example = example;
   }
 

modules/swagger-models/src/main/java/com/wordnik/swagger/models/RefModel.java

@@ -12,7 +12,7 @@ public class RefModel implements Model {
   private String description;
   private ExternalDocs externalDocs;
   private Map<String, Property> properties;
-  private String example;
+  private Object example;
 
   public RefModel(){}
   public RefModel(String ref){
@@ -63,10 +63,10 @@ public String getSimpleRef() {
   }
 
   @JsonIgnore
-  public String getExample() {
+  public Object getExample() {
     return example;
   }
-  public void setExample(String example) {
+  public void setExample(Object example) {
     this.example = example;
   }
 

samples/java-jersey-jaxrs/src/main/java/com/wordnik/swagger/sample/resource/SampleExceptionMapper.java

@@ -0,0 +1,61 @@
+/**
+ *  Copyright 2015 Reverb Technologies, Inc.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+package com.wordnik.swagger.sample.resource;
+
+import com.wordnik.swagger.sample.exception.ApiException;
+import com.wordnik.swagger.sample.exception.BadRequestException;
+import com.wordnik.swagger.sample.exception.NotFoundException;
+import com.wordnik.swagger.sample.model.ApiResponse;
+
+import javax.ws.rs.ext.*;
+import javax.ws.rs.core.Response;
+import javax.ws.rs.core.Response.Status;
+
+@Provider
+public class SampleExceptionMapper implements ExceptionMapper<Exception> {
+  public Response toResponse(Exception exception) {
+    if (exception instanceof javax.ws.rs.WebApplicationException) {
+      javax.ws.rs.WebApplicationException e = (javax.ws.rs.WebApplicationException) exception;
+      return Response
+          .status(e.getResponse().getStatus())
+          .entity(new ApiResponse(e.getResponse().getStatus(),
+              exception.getMessage())).build();
+    } else if (exception instanceof com.fasterxml.jackson.core.JsonParseException) {
+      return Response.status(400)
+          .entity(new ApiResponse(400, "bad input")).build();
+    } else if (exception instanceof NotFoundException) {
+      return Response
+          .status(Status.NOT_FOUND)
+          .entity(new ApiResponse(ApiResponse.ERROR, exception
+              .getMessage())).build();
+    } else if (exception instanceof BadRequestException) {
+      return Response
+          .status(Status.BAD_REQUEST)
+          .entity(new ApiResponse(ApiResponse.ERROR, exception
+              .getMessage())).build();
+    } else if (exception instanceof ApiException) {
+      return Response
+          .status(Status.BAD_REQUEST)
+          .entity(new ApiResponse(ApiResponse.ERROR, exception
+              .getMessage())).build();
+    } else {
+      return Response.status(500)
+          .entity(new ApiResponse(500, "something bad happened"))
+          .build();
+    }
+  }
+}