使用 Rails routes.rb 文件生成 API 参考文档的最佳方法是什么？答案

【问题标题】：What's the best way to generate an API reference document using a Rails routes.rb file?使用 Rails routes.rb 文件生成 API 参考文档的最佳方法是什么？
【发布时间】：2011-01-03 19:50:42
【问题描述】：

我正在尝试为我的 Rails 应用程序记录 API，我不禁想知道是否有更好的方法来基于我的 routes.rb 文件生成 XML 文件。我正在设想类似于rake routes 的输出，但采用更友好的 XML 类型格式。 Corey 有一些关于在路由文件 here 上使用反射/自省的有趣想法，但这并不是我所需要的。

请告诉我这是一个已解决的问题，我不是第一个想到这个的人。 :)

【问题讨论】：

如果您对 API 参考有其他要求或计划，能否细化这个问题？

标签： ruby-on-rails api routes rake introspection

【解决方案1】：

rake routes 是一个普通的 rake 任务：

https://github.com/rails/rails/blob/master/railties/lib/rails/tasks/routes.rake

也许你可以从中学到相关的东西，并编写一个新任务，以（-cough-）更友好的 xml 格式生成路由。 ;)

【讨论】：

【解决方案2】：

我真的找不到与您正在寻找的东西完全匹配的东西（这也让我感到惊讶），但您可以查看a sitemap gem 以开始您想要的东西。这可能必须是自定义代码......遗憾的是

【讨论】：

考虑到rake routes 是 28 行代码，它可能不是那么艰巨的任务。
他希望生成一个 XML 文件来记录 API。我猜想部分要求是整个 rake:routes 文件不是 API 的一部分。此外，rake 文件通过管道连接到 STOUT，他想要一个 XML 文件。我只是认为站点地图生成器是一个不错的起点。
这是一个很好的复杂规范满足的例子。请注意，rake routes 中的代码也不会输出所有路由。使用 Builder 生成 XML 并将其写入文件是轻而易举的事。