如何使用API​​文档

Question

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

我在JAVA语言中相对比较好，这意味着我可以编写简单的程序。 最近对于正在进行的项目，我被要求使用SOAPUI工具并且正在阅读SOAPUI API以便在Groovy中编写代码。在这样做时，我得到了这个问题。

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

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

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

应该具备哪些技能？如何培养这样的技能。

Answer 1

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

Answer 2

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

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

Answer 3

1. 完整阅读API并了解每个方法调用的要求。例如。一些调用是GET / POST方法。了解他们需要的参数以及他们返回的响应。
2. 使用API​​。通常有一个Sandbox系统，您可以在其中使用API​​调用等。
3. 编写您自己的代码（无论您喜欢）并使用它，直到您了解API的流程。

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

希望这有帮助。

Answer 4

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

另一件事告诉我一个循环，如果他们没有仔细阅读Groovy开头（像我一样），有人可能会觉得有用的是Groovy暴露所有属性而无需调用getter或setter。所以像myObj.myProp = 5这样的东西对应于API中的setMyProp（5）方法。简单的东西，但我正在抓挠我的头几个新人！