使用 Swagger/OpenAPI 规范指定要作为 GET 参数发送的数组

Question

The following swagger definition:

swagger: '2.0'
host: example.com
paths:
  /theResource:
    get:
      parameters:
        - $ref: '#/parameters/fields'
parameters:
  fields:
    name: fields
    description: Fields to return
    in: query
    type: array
    collectionFormat: multi
    uniqueItems: true
    items:
      type: string
      enum:
        - column1
        - column2
        - column3

Will generate the following URL, and the server will only receive fields equal to column3 .

http://example.com/theResource?fields=column1&fields=column2&fields=column3

How do I change it so that it sends an array in the parameter? For instance:

http://example.com/theResource?fields[]=column1&fields[]=column2&fields[]=column3

Answer 1

In PHP you can use http_build_query , that will construct proper query part of URL for you.

<?php

$query = http_build_query([
    'fields' => [
        'one', 'two', 'three'
    ],
]);

$url = "https://example.com/?".$query;

And yes, the fields[] syntax should do the trick.