apiary.io - 参数名称中的方括号

Question

我想知道是否可以在参数名称中包含方括号，这就是 Rails 对参数进行分组的方式。例如：

    + Parameters
        + person[age] (string) ... Person's age

现在，如果我包含方括号，则不会呈现参数。

谢谢！

score 2 · Accepted Answer

从技术上讲，URI 中不允许使用方括号，除非Internet Protocol Literal Address

RFC3513：

由 Internet 协议文字地址（版本 6 [RFC3513] 或更高版本）标识的主机通过将 IP 文字括在方括号（“[”和“]”）中来区分。这是 URI 语法中唯一允许使用方括号字符的地方。

这意味着方括号不应在参数名称中使用（未转义）。

目前的解决方案是手动转义括号。

将来，API 蓝图可能会自动为您转义不安全的字符。参考：

1 回答 1