我正在开发一个为外部开发人员提供 API 的网站。
每当更新 API（即修改参数、新端点等）时，我都必须手动更新文档。
所以我正在研究如何自动完成这个过程。这是我希望实现的目标：一旦我的源代码更新并提交到我的源代码控制，某种 API 注册表将被更新。所以我的文档可以是一个引用注册表并向查看者显示最新 API 的应用程序。
我的网站基于 Ruby on Rails。
问问题
69 次
1 回答
0
RDoc 是根据您的源代码自动生成的，它是 Rails 的默认设置。您的代码需要有据可查，但如果是，您可以运行
bundle exec rake doc:app
并且您的应用程序将生成可从doc/app/index.html. 我会看一下，看看这些文档是否符合您的需求。“类和模块索引”侧边栏中的链接包含所有方法的列表以及它们的源代码的可扩展视图。
我使用自定义 rake 任务将所有文档放在 Rails 公共文件夹中，以便直接从我的网站访问，并允许我添加多个自定义页面。我想你做一些只解析你的 API 文件的类似事情不会那么难。
链接：
于 2012-08-17T19:58:48.733 回答