我正在为一个网络服务制作前端,而另一家公司负责后端。我需要一个简单明了的方法来制作一个API调用的文档,这样我们可以一起合作编辑,而不会互相搞混。
有没有什么好的规范或示例,可以参考一下项目的API文档,这样就不会因为多次修改而变得一团糟呢?
对于一些小型的API,我开始使用谷歌文档。它的协作功能非常棒,你可以看到这个文档上所有的修改记录。
我选择的文档工具是:Sphinx。
其他的选择有:
不过,Sphinx真的很棒。