参数名称中的方括号

时间:2013-12-04 19:30:38

标签: apiary.io apiblueprint

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

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

现在,如果我包含方括号,则不会渲染参数。

谢谢!

1 个答案:

答案 0 :(得分:2)

Internet Protocol Literal Address

外,URI中不允许使用方括号

RFC3513:

  

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

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

现在的解决方案是手动转义括号。

将来,API蓝图可能会自动为您转义不安全的字符。请参阅: