微服务的集中式API文档

Question

我和我的团队目前正在并行构建多个服务.我们从头开始构建所有服务.我希望能够在一个页面/站点中自动显示所有服务的所有API端点.这将是有帮助的,因为(除其他外):

1. 我不必去多个文档站点来查看整个"系统"中可用的端点.

2. 确定是否应该拆分,组合或简单重构任何服务都是一个很好的第一步.

我们的一些服务是在Django和rest-swagger模块是一个很好的帮助.但我不知道如何将来自多个服务的rest-swagger文档合并到一个文档页面/站点中.

我目前正在浏览此网站以及与Netflix体验相关的任何内容,但无法找到解决我问题的方法.也许集中文档对于Netflix的600多项服务来说并不是什么大问题,但这很难相信.

任何人都可以建议一个工具或方法来为微服务架构中的所有服务提供组合的API文档吗？

我改变服务时会发生什么的理想情况:

1. 我点击链接查看我系统中的端点列表.
2. 队友更新服务及其文档.
3. 我刷新了我当前的页面,我看到了从第2步开始的更改.

Answer 1

有了我的经验，你就有了一些路。

1. http://readme.io/
2. 使用 JIRA、Redmine 制作 wiki。
3. 在 Github 中为专有文档创建一个存储库。
4. 谷歌文档。