如何使用 API 文档答案

【问题标题】：How to use API documentation如何使用 API 文档
【发布时间】：2011-04-13 16:01:41
【问题描述】：

人们通常说他们使用 API 文档和代码。

我的JAVA语言比较好，意思是我可以写简单的程序。最近，对于正在进行的项目，我被要求开发 SOAPUI 工具，并且正在阅读 SOAPUI API 以在 Groovy 中编写代码。在执行此操作时，我遇到了这个问题。

如何开始使用 API 文档（适用于任何语言/事物）？可以说，我想开始使用 Google Map API 或 Yahoo developer API。

是否有任何结构化的方式来阅读和理解 API？首先使用哪些类或如何调用或使用各种方法。

在阅读特定 API 之前应该做什么？如何通过阅读和理解 API 来熟悉创建事物并开始构建事物？

要做到这一点应该具备哪些技能？如何培养这样的技能。

【问题讨论】：

标签： java api soapui

【解决方案1】：

我建议您从教程和示例代码开始。实际上，API 文档是一种参考。

【讨论】：

【解决方案2】：

当我开始使用新工具/API 时，我总是首先阅读文档以了解它是什么/它做什么/它是如何工作的。文档通常指向一个教程，这是我接下来要做的。然后我将尝试创建我自己的非常简单的测试应用程序，它以相当简单的方式使用 API。

此时我已经了解了主要的类，并且通常会阅读它们的 javadocs。我真的只会在需要时才使用其他较少使用的类或额外功能。

【讨论】：

这可能适用于您有一定基础的编程语言，新工具或 Google MAP API 怎么样？
@karthi 我想说这种方法与新的 API 比与新的编程语言更相关。直接阅读 API 只会造成混乱。信息太多，没有任何上下文很难理解。

【解决方案3】：

完整阅读 API 并了解每个方法调用的要求。例如。一些调用是 GET/POST 方法。了解它们需要哪些参数以及它们返回的响应。
使用 API。通常有一个沙盒系统，您可以在其中玩 API 调用等。
编写您自己的代码（随心所欲）并使用它，直到您了解 API 的流程。

一旦掌握了窍门，就可以设计一个最适合 API 的架构。从本质上讲，阅读文档对于理解 API 至关重要。

希望这会有所帮助。

【讨论】：

当我开始使用 API 时，我迷失了 CLASSES 和 METHODS 和 INTERFACES 链接在一起的方式。如何避免这种情况？
我不太了解你，请详细说明。

【解决方案4】：

我最近也试图弄清楚它们，主要是试图找出我在为测试用例编写测试脚本时可以访问的对象是什么。我无法确定日志、上下文、testStep 等与 API 相关的类型。对我来说，错误消息是一座金矿。当我尝试出错时，它清楚地说明了对象的类型，并在 API 中为我指明了正确的方向。

另一个让我陷入循环的事情是，如果有人没有仔细阅读有关 Groovy 的内容（比如我），他们可能会觉得很有帮助，那就是 Groovy 公开了所有属性，而无需调用 getter 或 setter。所以像 myObj.myProp = 5 这样的东西对应于 API 中的 setMyProp(5) 方法。简单的东西，但我为一些新手而摸不着头脑！

【讨论】：