CODEWITHSUNDEEP
arraysobjectswagger
Lorenzo Tassone
Lorenzo Tassone

Reputation: 383

Swagger array of objects

I am having some issues with swagger: I have an array of objects (address) described in this way in the .yaml file:

Address:
  properties:
    street:
      type: string
    city:
      type: string
    state:
      type: string
    country:
      type: string

and this is the other yaml file with the definitions of the API (address is a params):

 - name: addresses
   in: formData
   description: List of adresses of the user. The first one is the default one.
   type: array
   items:
     $ref: '#/definitions/Address'

And this is the text I put in the swagger UI:

[
  {
    "street": "Bond street",
    "city": "Torino",
    "state": "Italy",
    "country": "Italy"
  }
]

but in node.js, if I print what I receive:

{"addresses":["["," {"," \"street\": \"Bond street\","," \"city\": \"Torino\","," \"state\": \"Italy\","," \"country\": \"Italy\""," }","]"]}

And I get a parsing error... There are some extra [ and ". It seems that swagger parse it as string (?)

Upvotes: 2

Views: 21949

Answers (1)

Helen
Helen

Reputation: 98022

To send JSON data, you need to use use an in: body parameter (not in: formData) and specify that the operation consumes application/json. formData parameters are used for operations that consume application/x-www-form-urlencoded or multipart/form-data.

paths:
  /something:
     post:
       consumes:
         - application/json
       parameters:
         - in: body
           name: addresses
           required: true
           schema:
             type: array
             items:
               $ref: "#/definitions/Address"  # if "Address" is in the same file
               # or
               # $ref: "anotherfile.yaml#/definitions/Address"  # if "Address" is in another file

Upvotes: 8

Related Questions