如何从routes.rb文件生成PDF或HTML格式的URL API文档

Question

我需要将URL路线文档导出到PM，

她需要阅读 HTML 格式或 PDF 格式的网址格式。

不知何故， rake路由生成的API格式对于一般人来说太难看了。

有没有宝石可以生成更漂亮的URI格式？

我不需要显示前缀和控制器＃操作

提前致谢

Answer 1

当您运行rails app时，在浏览器中点击错误的网址并获取错误页面 - 您拥有所有路线。

运行您的应用并转到localhost：3000 / somenoneexistingroute

您的HTML格式为

Answer 2

对于快速而脏的URI模式列表，您可以使用命令行：

rake routes | cut -c41-95 | sort --key=1.10

rake routes的输出具有固定的列宽，因此您必须调整以上内容以便为应用的输出定制它，但上面的示例会捕获列之间的字符41和95并按字母顺序排列它们。只需调整第一个数字，直到斜线是每一行的第一个字符，第二个数字直到控制器名称消失。

排序中的--key确保列表在斜杠后面的字符上按字母顺序排列，它从第一个字段（1.10）开始计算10个字符，跳过HTTP谓词。如果您希望它们按自然顺序排列，请从命令中删除| sort...。

如果您正在使用Windows，还有其他方法可以执行此操作，或者您可以安装Gnu工具以进行切割和操作。排序