How can I describe complex json model in swagger

Question

I'm trying to use Swagger to describe web-api I'm building. The problem is that I can't understand how to describe complex json object?

For example, how to describe this objects:

{   name: "Jhon",   address: [     {       type: "home",       line1: "1st street"     },     {        type: "office",        line1: "2nd street"     }   ] } 

Answer 1

Okay, so based on the comments above, you want the following schema:

{   "definitions": {     "user": {       "type": "object",       "required": [ "name" ],       "properties": {         "name": {           "type": "string"         },         "address": {           "type": "array",           "items": {             "$ref": "#/definitions/address"           }         }       }     },     "address": {         "type": "object",         "properties": {             "type": {                 "type": "string",                 "enum": [ "home", "office" ]             },             "line1": {                 "type": "string"             }         }     }   } } 

I've made a few assumptions to make the sample a bit more complicated, to help in the future. For the "user" object, I've declared that the "name" field is mandatory. If, for example, you also need the address to be mandatory, you can change the definition to "required": [ "name", "address" ].

We basically use a subset of json-schema to describe the models. Of course not everyone knows it, but it's fairly simple to learn and use.

For the address type you can see I also set the limit to two options - either home or office. You can add anything to that list, or remove the "enum" entirely to remove that constraint.

When the "type" of a property is "array", you need to accompany it with "items" which declares the internal type of the array. In this case, I referenced another definition, but that definition could have been inline as well. It's normally easier to maintain that way, especially if you need the "address" definition alone or within other models.

As requested, the inline version:

{   "definitions": {     "user": {       "type": "object",       "required": [         "name"       ],       "properties": {         "name": {           "type": "string"         },         "address": {           "type": "array",           "items": {             "type": "object",             "properties": {               "type": {                 "type": "string",                 "enum": [                   "home",                   "office"                 ]               },               "line1": {                 "type": "string"               }             }           }         }       }     }   } }