问理想的API文档应该是怎样的？
EN

Stack Overflow用户

提问于 2016-07-25 13:40:12

回答 1查看 66关注 0票数 0

我创建了如此多的API。我们计划将其公之于众。有这么多的API和它的响应。每个API可以使用多个参数集进行调用，根据调用参数可能会导致不同的结果集。

我不太了解如何用不同的参数来记录所有这些API。

发布于 2016-07-25 13:52:43

在使用新的api时，我总是检查谁的文档容易理解。我建议你，如果可能的话，试着为你的api创建一个视频教程(它是什么？以及如何使用它？)没有什么能比一个视频更好的了，它实际地解释了一切。

对于书面文档，请确保详细说明了可能影响您的api的所有细节。一定要提到你的api的所有限制。很多时候，开发人员几乎忘记了要提及的事情，而最终用户需要花费数小时才能弄清楚这一限制。

祝好运!您先请!

票数 1

页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持

原文链接：

https://stackoverflow.com/questions/38560420

复制

相似问题

问理想的API文档应该是怎样的？EN