3

尝试为使用Rails 的数组参数表示法的 API URI 使用资源丰富的文档时，我运气不佳

例如（为了清楚起见，未编码的 URL）：

/api/v2/profiles?ids[]=35&ids[]=47&ids[]=12&ids[]=132

和实际编码的 URL：

/api/v2/profiles?ids%5b%5d=35&ids%5b%5d=47&ids%5b%5d=12&ids%5b%5d=132

这不起作用：

## Profiles [/api/v2/profiles{?ids%5b%5d*}]

### List profiles [GET]

+ Parameters

    + ids%5b%5d (required, number) ... ID of a profile to fetch. May be specified multiple times.

针对 beta 3 列布局进行测试。还没有尝试过旧布局。

4

2 回答 2

6

此时我将运行不带方括号的参数（描述），如下所示：

# Rails Params

## Profiles [/api/v2/profiles{?ids%5b%5d*}]

### List profiles [GET]

+ Parameters
    + ids (required, number) ... ID of a profile to fetch. May be specified multiple times.

        For example: `profiles?ids[]=35&ids[]=47&ids[]=12`


+ response 204

您可以在此处找到在 Apiary 中渲染的示例。

然而，这种情况需要改进。我在 API Blueprint 解析器上创建了问题来跟踪它。

于 2014-04-22T18:59:33.613 回答
2

这很好地作为一种解决方案。

### Get a group of specified items [GET /statistics?ids[]={id1}&ids[]={id2}]

+ Parameters
    + id1 (number, `1`)
    + id2 (number, `2`)
    + idx (number, `any ID`)

+ Response 200 (application/json; charset=utf-8)

        {
            "items": [
                {
                    "id": 1,
                    "value": "Item 1"
                },
                {
                    "id": 2,
                    "value": "Item 2"
                },
            ]
        }

它清楚地传达了用法，并在交互式文档中使事情变得清晰和可用。

于 2015-06-19T03:28:37.517 回答