Java 如何使用API文档

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

我的JAVA语言相对来说还行，这意味着我可以编写简单的程序。 最近，在我所从事的项目中，我被要求使用SOAPUI工具并阅读SOAPUIAPI，以便在Groovy中编写代码。当我这样做的时候，我得到了这个问题

如何开始使用API文档（针对任何语言/事物）？ 让我们说，我想开始使用谷歌地图API或雅虎开发者API

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

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

---

一个人应该具备什么样的技能才能做到这一点？如何培养这些技能

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

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

到现在为止，我已经知道了主要的类，并且通常阅读了它们的javadocs。我真的只会在需要的时候才开始使用其他较少使用的类或额外的特性

全面阅读API并理解每个方法调用的要求。例如，有些调用是GET/POST方法。了解他们需要什么参数以及他们返回的响应

使用API。通常有一个沙箱系统，您可以在其中使用API调用等

编写您自己的代码（不管您喜欢什么）并使用它，直到您理解API的流程

一旦掌握了窍门，设计一个最适合API的体系结构。本质上，阅读文档对于理解API至关重要

---

希望这能有所帮助。

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

---

另一件让我陷入困境的事情是，如果一开始没有仔细阅读Groovy的相关内容（像我一样），Groovy会在不需要调用getter或setter的情况下公开所有属性，这可能会对其他人有所帮助。所以像myObj.myProp=5这样的东西对应于API中的setMyProp（5）方法。简单的东西，但我抓挠我的头为一些新的在它

这可能适用于你有基础的编程语言，一个新的工具或者谷歌地图API怎么样？@karthi我想说这种方法对于一个新的API比对于一个新的编程语言更相关。直接阅读API只会引起混乱。信息太多，没有任何上下文，很难理解。当我开始使用API时，我对类、方法和接口链接在一起的方式感到迷茫。如何避免这种情况？我不太明白，请详细说明。