如何使用API文档

Question

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

我的Java语言水平相对较好，这意味着我可以编写简单的程序。最近，在我工作的项目中，我被要求开发SOAPUI工具，我正在阅读SOAPUI API，以便在Groovy中编写代码。在这样做的时候，我遇到了这个问题。

如何开始使用API文档(适用于任何语言/事物)？比方说，我想开始使用Google Map API或Yahoo developer API。

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

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

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

Answer 1

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

Answer 2

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

到目前为止，我已经了解了主要的类，并且通常会读取它们的javadoc。当我需要时，我真的只会使用其他较少使用的类或额外的功能。

Answer 3

1. 通读API并理解每个方法调用的requirements。例如，有些调用是GET/POST方法。了解它们需要哪些参数以及它们返回的响应。
2. 使用该接口。通常有一个沙盒系统，您可以在其中使用应用编程接口调用等。
3. 编写您自己的代码(无论您喜欢什么)，并使用它，直到您了解应用编程接口的流程。

一旦你掌握了它的诀窍，设计一个最适合API的架构。本质上，为了理解API，阅读文档是必不可少的。

希望这能有所帮助。