好的示例/模板/最佳实践API文档

Question

我为Web服务创建前端，而后端创建另一家公司。我需要一个好的，简单易懂的方法来制作API调用文档，我们可以一起协作和编辑，而不会互相混淆。

项目API文档是否有任何良好的规范/示例等，所以这不会导致很多重写？

Answer 1

我选择的文档：Sphinx。

其他：

• epydoc
• pylit

但是Sphinx非常棒。

Answer 2

对于小型API，我开始使用Google文档。它的协作功能非常棒，您可以看到该文档所做的所有更改的列表。