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

标签 javascript python ajax api specifications

我正在为 Web 服务创建前端,而另一家公司正在创建后端。我需要一种好的、简单且易于理解的方式来制作 API 调用的文档,我们可以在不混淆的情况下共同协作和编辑。

项目 API 文档是否有任何好的规范/示例等,因此这不会因多次重写而变得一团糟?

最佳答案

我的文档选择:Sphinx .

其他:

但是 Sphinx 非常棒。

关于javascript - 好的示例/模板/最佳实践 API 文档,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/7333852/

相关文章:

javascript - typescript - 字符串字面量类型到类型字符串

javascript - Ionic 和 Angular 完全陌生,需要有关外部 json 请求的建议

python - Django 中唯一标识多对多关系

JavaScript 和动态表单创建

javascript - 将参数传递给 Window[callback] 函数

javascript - Facebook C# SDK 与 Javascript SDK 的性能注意事项

javascript - MVC 4 Ajax 调用未进行

java - Spring MVC : triggering and terminating a backend method by turning on and off a switch on a web page

python - 如何解决 Python TypeError?

python - 如何在 flask-socketio 中保持活力?