如何使用API文档

Question

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

我在JAVA语言方面还可以，也就是说我能写简单的程序。 最近为了项目，我被要求使用SOAPUI工具，并阅读SOAPUI API以便用Groovy编写代码。在这个过程中，我有了一个问题。

如何开始使用API文档（对于任何语言/事物）？ 比如说，我想开始使用Google Map API或Yahoo开发者API。

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

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

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

- karthi

Answer 1

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

- Adeel Ansari

Answer 2

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

到这个时候，我已经了解了主要的类，并且通常会阅读它们的javadocs。只有在有需要的时候，我才会去了解其他不常用的类或额外的功能。

- Qwerky

---

这可能适用于编程语言，其中您将拥有一些基础知识，那么对于新工具或谷歌地图API呢？ - karthi

@karthi 我认为这种方法更适用于新的 API 而不是新的编程语言。直接阅读 API 只会导致困惑。信息太多，没有任何上下文是很难理解的。 - Qwerky

Answer 3

阅读API的全部内容并理解每个方法调用的要求。例如，一些调用是GET/POST方法。了解它们需要哪些参数以及它们返回的响应。

使用API进行实验。通常有一个沙盒系统，您可以在其中玩弄API调用等。

编写自己的代码（任何方式都可以），并尝试操作它，直到您理解API的流程为止。

一旦您掌握了它，设计最适合API的架构。实际上，在理解API方面阅读文档是必不可少的。

希望这能帮到您。

- Buhake Sindi

---

当我开始使用API时，我会迷失在类、方法和接口之间的联系中...如何避免这种情况？ - karthi

我不太明白你的意思，请详细说明。 - Buhake Sindi

Answer 4

最近我也在尝试弄清楚它们，主要是在编写测试用例的测试脚本时追踪我可以访问的对象是什么。我一直在努力弄清楚日志、上下文、测试步骤等的类型与API的关系。对我来说，错误消息是一个宝藏。当我尝试错误的东西时，它清楚地说明了对象的类型，并指引我在API中朝正确的方向前进。

还有一件事情让我感到困惑，如果有人没有仔细阅读Groovy的相关资料（就像我一样），他们可能会发现这很有帮助：Groovy无需调用getter或setter即可公开所有属性。所以像myObj.myProp = 5这样的东西对应于API中的setMyProp(5)方法。虽然很简单，但我作为新手还是想了好几天才明白！

- Dustin