Feature/example values

[fehguy]

Adds example values for query, header, form, and path params. The goal is to differentiate between the default value, which is intended to be "what the server will do by default if no value is passed". The example construct is not supported in the 2.0 specification so it is being exposed using x-example for scalar parameters and x-examples for body parameters.

For example:

@ApiOperation(value = "test")
@GET
@Path("external/info")
public void queryExample(@ApiParam(value = "test",
        example = "a,b,c") @QueryParam("tenantId") ArrayList<String> tenantId) {
    return;
}

This is represented as:

{
  "name" : "tenantId",
  "in" : "query",
  "description" : "test",
  "required" : false,
  "type" : "a,b,c",
  "items" : {
    "type" : "string"
  },
  "x-example" : "a,b,c"
}

will allow the string array to have an example value of a, b, c

Likewise for a post body:

@ApiOperation(value = "test")
@POST
@Path("external/info")
public void postTest(@ApiParam(value = "test",
        examples = @Example(value = {
                @ExampleProperty(mediaType="application/json", value="[\"a\",\"b\"]")
        })) ArrayList<String> tenantId) {
    return;
}

This is represented as:

{
  "in" : "body",
  "name" : "body",
  "description" : "test",
  "required" : false,
  "schema" : {
    "type" : "array",
    "items" : {
      "type" : "string"
    }
  },
  "x-examples" : {
    "application/json" : "[\"a\",\"b\"]"
  }
}

[webron]

This is not used by the code.

[fehguy]

I've addressed the two comments from before.

[fehguy]

• Need to make sure the example value has the correct type, currently always string.