api - 微服务的集中式 API 文档

Question

关闭。这个问题不符合Stack Overflow guidelines .它目前不接受答案。












想改进这个问题？将问题更新为 on-topic对于堆栈溢出。

4年前关闭。




Improve this question




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

我不必去多个文档站点来查看我的整个“系统”中有哪些可用的端点。

确定是否应该拆分、组合或简单重构任何服务将是一个很好的第一步。

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

我目前正在浏览 this site以及与 Netflix experience 相关的任何内容但找不到我的问题的解决方案。对于 Netflix 的 600 多种服务，集中式文档可能没什么大不了的，但这很难相信。

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

我对更改服务时发生的情况的理想情况:

我单击链接以查看系统中的端点列表。

队友更新服务及其文档。

我刷新了当前的页面，我看到了从第 2 步开始的更改。

Answer 1

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

http://readme.io/

使用 JIRA、Redmine 创建一个 wiki。

在 Github 中为独家文档创建一个 repo。

谷歌文档。