我正在创建这么多API。我们计划公开发布。有很多API及其响应。可以使用多组参数调用每个API,并且可能根据调用参数导致不同的结果集。
我不太清楚如何使用不同的参数记录所有这些API。
答案 0 :(得分:1)
在使用新api时,我总是检查哪些文档易于理解。 我建议你,如果可能的话,尝试为你的api创建一个视频教程(它是什么?以及如何使用它?)没有比一个实际解释一切的视频更好的了。
对于书面文档,请确保您正在详细说明可能会影响您的API的所有细微之处。请务必提及api的所有限制。很多时候,开发人员忘记了一些事情,而最终用户需要花费很多时间才能找出这种限制。
祝你好运!来吧!