创建Blueprint API doc时如何在URL中格式化基于哈希的参数？

Question

使用Rails方法在URL的参数中添加哈希值，如下所示：

 http://api.example.com?person[first]=Jane&person[last]=Doe&person[email]=jane@doe.com

如何设置API蓝图文档的格式以容纳可用的哈希列表？

• 参数
  • person [first]（必填，字符串，Jane）...名字

执行文档时这不合法。

欢迎任何想法或提示！

Answer 1

每https://tools.ietf.org/html/rfc3986#section-3.2.2，您必须在URI中转义[]。因此，您需要这样做：

• 参数
  • person％5Bfirst％5D（必填，字符串，简）......

如果您在蓝图中模板化URI，那么您也必须在那里转义[]。

仅供参考，原始文档中有一个错误，用于Apiary.io中的代码生成（如果您正在使用它），并且生成的URI目前无法正确处理转义。您可以打开没有该问题的Beta文档。