从简单的数据检索到复杂的集成，了解如何使用 API 对于现代软件开发至关重要。本指南揭开了这一过程的神秘面纱，为您提供了提出 API 请求、解码响应以及在代码中安全实施这些功能强大的连接器所需的洞察力。您将逐步了解关键概念，从而在自己的项目中有效利用 API。

关键路径

  • API（应用程序编程接口）对于实现软件应用程序之间的通信、定义如何提出请求、使用的数据格式和要遵循的协议至关重要。
  • 有各种类型的API，如REST、SOAP、GraphQL和WebSocket，每种都有独特的功能；选择正确的类型取决于应用程序的特定需求。
  • 使用API密钥和授权方法保护API访问至关重要，开发人员必须正确创建、发送和处理API请求，同时确保其应用程序中适当的API集成和性能监控。

了解API：基础知识

什么是API？
什么是远程调用?
什么是RESTful API
初学者的API困惑有哪些？
适合初学者的API工具有哪些？

选择合适的API技术架构？

API架构是多样化的，包括几种类型，每种类型都具有独特的优势和应用程序。其中，REST（表示状态传输）API，也称为RESTful API，是最受欢迎的API架构之一。在开放API场景及中小型项目中，REST API成为事实上的标准。其它几种API架构如下:

SOAP API

SOAP（简单对象访问协议）API通常用于涉及正式合同和长期运行流程的场景。它们用于从服务器创建、检索、更新或删除记录等操作。适用于其它内部数据集成、复杂事务性业务集成。

GraphQL API

GraphQL API使客户能够检索符合其要求的精确数据，通常使用JSON作为数据格式。适用于数据服务共享类场景。

WebSocket API

WebSocket API支持实时通信和更新，这在需要实时交互的应用程序中证明是不可或缺的。适用于在线会议、在线游戏等高实时场景。
基于异步事件模型的API技术还有Async API、WebHooks可以选择。

使用API密钥和授权

API密钥和授权方法对于保护API的访问和管理数据使用不可或缺。API密钥是一个独特的字符序列，用于验证和授权用户访问API，作为规范API访问和保护敏感信息的安全措施。获取API密钥通常涉及登录API提供商网站上的开发人员帐户，访问API密钥部分，并请求新密钥。

另一方面，API授权验证发起API请求的用户或应用程序的身份，确保他们拥有与API及其资源交互的必要权限。这通常使用OAuth等标准完成，该标准允许网站或应用程序访问其他Web应用程序的资源，而无需泄露用户凭据，为授予权限和访问受保护资源提供了安全和受监管的方法。

阅读API文档

API文档是开发人员的综合指南，概述了有效使用API的基本信息。它包括：

  • API的全面描述，详细说明其功能、约束和先决条件
  • 每个调用、参数和响应的示例
  • 代码示例、参考文献、教程和描述性解释

为了充分利用API文档，建议首先熟悉API术语，然后深入研究API概述以了解其目标和功能。API参考提供了有关可访问资源及其交互方法的详细信息。最后，查看可用的教程可以帮助获得有关API利用的实践知识。

创建您的第一个API请求

准备好您的第一个API请求了吗？该过程包括端点选择、参数和标头配置，以及API响应管理。让我们把它分成三个步骤。

1)选择端点

API端点本质上是一个特定的URL，提供对服务器上资源的访问。它是API客户端和API服务器之间的通信点，接收请求并发送响应。每个端点由以下部分组成：

  • HTTP方法
  • 端点URL
  • 标题
  • body

此API提供商提供了一种有组织的方式来管理私有API功能。

在选择端点时，重要的是要考虑以下因素：

  • 文档
  • 库
  • 一致性
  • 支持
  • 名声
  • 价格
  • 数据隐私

此外，了解POST和GET等HTTP方法之间的区别至关重要。GET API端点用于数据检索，而POST API端点用于数据创建。GET请求在URL中可见，因此被认为不太安全，而POST请求更安全，因为数据在请求主体中传输并从URL中隐藏。

2)设置参数和标头

参数和标头是API请求的关键组成部分，允许您自定义请求并向服务器提供其他信息。API请求参数是可配置的选项，您可以将其包含在端点中以影响响应，作为搜索的过滤器。您可以将这些参数设置为附加到URL的键值对或作为请求头中包含的头参数。

另一方面，标头向服务器提供补充元信息。这可以包括有关请求、身份验证详细信息等的数据。要用JavaScript等语言设置标头，使用XMLHttpRequest对象的“setRequestHeader”等方法。

了解参数和标头的功能和实现对于有效使用API至关重要。

3)处理API响应

一旦您提出API请求，您将收到回复。管理这些响应是使用API的关键部分。其中一个关键方面是理解状态代码。HTTP响应状态代码指示特定HTTP请求是否已成功完成，提供有关API请求结果的宝贵信息。

API响应可以以各种格式返回，包括：

  • JSON
  • XML
  • 纯文本
  • 二进制

根据您的编程语言，可以使用不同的方法来解析这些数据，例如javascript对象符号（JSON）。例如，在Python中，您可以使用json模块从API响应中解析JSON数据。在Java中，DOM或SAX解析器等库可用于解析XML数据。

了解如何处理和解释API响应是成功与API交互的关键。

将API集成到您的应用程序中

现在，掌握了提出API请求和管理响应的知识，是时候探索根据您的要求选择合适的API，并将API调用合并到您的应用程序代码中了。

根据您的需求选择正确的API

为您的应用程序选择正确的API是一个关键的决定，可能会影响应用程序的功能和性能。您的业务需求、预算和API与现有应用程序的兼容性都是在此过程中需要考虑的重要因素。

测试和自动化脚本可用于评估API与现有应用程序的兼容性。在为业务目的选择API时，考虑以下因素也很重要：

  • 易用性
  • 可扩展性
  • 安全
  • 灵活性
  • 完整性

在您的代码中实现API调用

一旦您选择了正确的API，下一步就是将API调用集成到您的代码中。这涉及：

  1. 选择正确的API
  2. 如有必要，获取API密钥
  3. 向API端点发出HTTP请求
  4. 收到回复
  5. 处理代码中的响应。

根据应用程序的技术堆栈，您可以使用不同的库或工具进行这些API调用。例如：

  • 在Python应用程序中，您可以使用请求库。
  • 在Node.js应用程序中，Axios、node-fetch或SuperAgent等库可能很有用。
  • 即使在PHP等语言中，使用cURL等库或通过开发实用程序函数进行API调用也是可行的。

在代码中实现API调用时，遵循最佳实践也很重要，例如使用名词进行资源识别，确保适当的HTTP头，以及实施彻底的错误处理。

参考资料

英文原文: How to use API？

Keyword: api平台