php - 我可以让 swagger-php 在查询字符串上使用数组吗？

Question

我使用 Swagger-php。当我在查询字符串上定义一个参数时，它可以是一个数组。但据我所知，它不支持这种查询字符串:

https://api.domain.tld/v1/objects?q[]=1&q[]=5&q[]=12

我相信这会被设置 in the collectionFormatfield如果可能的话。目前我一直在使用 pipes，但我想使用上面的格式，并且让 Swagger-UI 也反射(reflect)这一点。但是，我读了 this github issue这让我想知道这是否真的可行，而我只是错过了它？

我的 Swagger-PHP 定义示例:

/**
*     @SWG\Parameter(
*         name="ids",
*         in="query",
*         description="A list of IDs (separated by pipes) to filter the Returns",
*         required=false,
*         type="array",
*         @SWG\Items(
*             type="integer",
*             format="int32"
*         ),
*         collectionFormat="pipes"
*     )
*/

这会产生以下 JSON:

"parameters": {
    "ids": {
        "name": "ids",
        "in": "query",
        "description": "A list of IDs (separated by pipes) to filter the Returns",
        "required": false,
        "type": "array",
        "items": {
            "type": "integer",
            "format": "int32"
        },
        "collectionFormat": "pipes"
    }
}

Answer 1

/**
 *     @SWG\Parameter(
 *         name="q[]",
 *         in="query",
 *         description="A list of IDs (separated by new lines) to filter the Returns",
 *         required=false,
 *         type="array",
 *         collectionFormat="multi",
 *         uniqueItems=true,
 *     )
 */

这将导致类似于此的结果

{
    "name": "q[]",
    "in": "query",
    "description": "type",
    "required": false,
    "type": "array",
    "collectionFormat": "multi",
    "uniqueItems": true
}