【发布时间】：2011-11-12 03:04:13
【问题描述】：
我正在为 Web 服务创建前端，而另一家公司则在创建后端。我需要一种好的、简单且易于理解的方式来制作 API 调用文档，我们可以协作处理和编辑，而不会相互混淆。
项目 API 文档是否有任何好的规范/示例等，这样不会因为许多重写而陷入混乱？
【问题讨论】：
-
整个 Python 库是项目 API 文档的一个很好的例子。似乎您只需从这里开始。 docs.python.org/library。用你已有的作为例子有什么问题？
-
为了完整起见，我假设后端将用 Python 编写。您使用的标签表明了这一点，但您没有明确表示。
-
@MortenSiebuhr 是的，这是真的，但我认为这并不重要，因为我不了解 Python 作为一门语言，仍然需要为 API 的功能做出贡献。
标签： javascript python ajax api specifications