Pass array as query parameter in Swagger OpenApi 3.0

Question

Ive currently given the below code to get an array of values as query paramters (in Node-express, nodejs v14.17 and OpenAPI version 3.0.1),

       - name: abcd
          description:  abcd
          in: query
          required: false
          schema:
            type: array
            items:
              type: string

but it send the req as an array of values(type is object) only if there are atleast two of them. For a single value, the type is string.How to always get req as array itself?

For example, if i give a single value say
"Hello", console.log(typeof(req.query["abcd"]),req.query["abcd"])
O/P: string Hello
but if i give "Hello" and "World",
O/P: object ['Hello','World']

Your array parameter definition is correct. Please post your controller code. What Node.js OpenAPI library do you use? — Helen
– Helen, Commented Jul 20, 2021 at 10:10

Helen · Accepted Answer · 2021-07-20 18:36:11Z

28

As this answer explains, when a query parameter gets passed a single value, e.g. ?abcd=hello, Express parses it as a regular value (i.e. string) rather than an array.

To pass a one-value array, you need to append [] at the end of the query parameter name, i.e. ?abcd[]=hello. This means you need to change the parameter name in your OpenAPI file:

       - name: abcd[]    # <------------
         description:  abcd
         in: query
         required: false
         schema:
           type: array
           items:
             type: string

answered Jul 20, 2021 at 18:36

Helen

99.8k18 gold badges280 silver badges352 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Pass array as query parameter in Swagger OpenApi 3.0

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related