apiblueprint - 使用 Rails 数组表示法的查询字符串参数的 API Bluprint 文档

Question

我没有太多运气尝试为使用 Rails' array parameter notation 的 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 列布局对此进行测试。没有用旧布局尝试过。

Answer 1

此时我将运行不带方括号的参数(描述)，如下所示:

# 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 here 中找到呈现的示例.

但是这种情况需要改进。我创建了 issue在 API 蓝图解析器上进行跟踪。