我正在开发一个为外部开发人员提供API的网站。
无论何时更新API（即修改的参数，新的终点等），我都必须手动更新文档。
所以我正在研究如何自动完成这个过程。以下是我希望实现的内容：一旦我的源代码更新并提交给我的源代码控制，就会更新某种API注册表。所以我的文档可以是一个引用注册表的应用程序，并向观众展示最新的API。
我的网站基于Ruby on Rails。
答案 0 :(得分：0)
RDoc是根据您的源代码自动生成的，它默认使用Rails。您的代码需要有详细记录，但如果是，您可以运行
bundle exec rake doc:app
您的应用将生成可从doc/app/index.html访问的文档。我会看一下，看看这些文档是否符合您的需求。 “类和模块索引”侧栏中的链接包含所有方法的列表，其中包含可扩展的源代码视图。
我使用自定义rake任务，将所有文档放在Rails公共文件夹中，以便直接从我的网站访问，并允许我添加多个自定义页面。我想你做类似的事情只会解析你的API文件并不难。
链接：