Logo
Section 1 / 5

API简介

了解应用程序编程接口(API)及其使用方法。

导入

API简介

了解应用程序编程接口(API)及其使用方法。

什么是 API?

API(应用程序编程接口) 是一种服务,由一组协议组成,用于实现应用程序之间的通信。简而言之,它充当两个应用程序之间的中介,使它们能够相互通信。例如,我们大家都使用过需要通过 Google 或 Facebook 账号注册或登录的应用程序。通常,在用户被允许访问某个应用之前,这些应用程序之间会共享数据以完成身份验证。这一切都是通过 API 实现的。

...
API 工作原理示意图

REST API

上述示例展示了 REST API 的工作方式。REST 是 表述性状态转移(Representational State Transfer)的缩写。REST API 使用 HTTP 协议在服务器和客户端之间传输数据。由于 HTTP 协议是无状态的:服务器不会记住之前的请求,因此 REST 应用要求每次请求都包含理解该请求所需的所有信息。这意味着客户端向服务器发出的每个请求都是独立的。为了让服务器清晰地理解请求,必须提供额外的信息,如查询字符串、请求头、请求体或 URL 的一部分(只要请求中包含了所有必要信息即可)。

REST API 的方法

REST API 方法
这些是 API 传递给服务器的 HTTP 方法,用于查询数据库并请求信息。它们通常被称为 CRUD 方法。让我们回顾一下 CRUD 的含义:

  • Create:使用 POST 方法将数据发送到服务器,以创建一个资源。
  • Read:使用 GET 方法从指定资源请求数据。
  • Update:使用 PUT 方法将数据发送到服务器,用于创建或更新资源。
  • Delete:使用 DELETE 方法删除指定的资源。

测试 API

我们将使用名为 Postman 的工具,在测试环境中通过上述方法来测试 API。

要测试一个 API,首先需要获取其 URL 以连接到服务器。API 的 URL 通常分为两部分:基础 URL 和 端点 URL。基础 URL 用于连接到服务器,而 端点 URL 则定义并指定我们请求的数据类型。以下是一个示例:CoinCap API。

以 CoinCap API 为例:

  • https://docs.coincap.io:代表 基础 URL
  • /v2/assets:代表我们请求数据的端点,用于指定感兴趣的资源内容。

/v2/assets

在 URL 中,v2 表示 API 的版本。在本例中,这是 CoinCap API 的第二个版本。assets 部分表示 API 中可用的数据类型。在此情况下,该端点返回所有列出的加密货币信息,以 JSON 格式呈现,包括当前价格、排名、名称等其他相关信息。

如果我们把 bitcoin 作为端点,就可以直接从 CoinCap 服务器请求比特币的数据:api.coincap.io/v2/assets/bitcoin

以下是使用 GET 方法在 API 测试环境中运行该 URL 后得到的响应示意图。

Postman API 响应(JSON 格式)

了解了 API 的工作原理后,我们来看下面的代码。

No configuration found for ID: 1b1b34d7ec9afb5bd50d221f1b1c02e13146ced0ae45d14e220cb14033017f8a

我们可以使用上述 Docker 容器来测试 API 端点。使用方法如下:点击 “Run”,然后打开 “Terminal” 标签页。执行 export DISPLAY=:1.0 后,输入 postman 并按下回车键。最后,打开输出窗口即可访问 Postman 的用户界面,并开始进行测试。

MVVM 架构

管理 API 密钥