ruby-on-rails - 创建 Blueprint API 文档时如何在 URL 中格式化基于哈希的参数？

Question

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

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

如何格式化 API Blueprint 文档以容纳可用哈希列表？

• 参数
  • person[first] (required, string, Jane) ... 名字

当我执行文件时，这是不合法的。

欢迎任何想法或提示！

Answer 1

根据https://www.rfc-editor.org/rfc/rfc3986#section-3.2.2，您必须在 URI 中转义 []。因此，您需要执行以下操作：

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

如果您在蓝图中模板化了 URI，您还必须在此处转义 []。

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