[第2部分] REST API 组件及其解读方法 - Skiplevel

REST API 组件及其解读方法

在本篇文章中，我们将深入探讨 REST API 的基本组成部分，帮助您更好地理解、分析、交互和调试这些 API。通过掌握这些知识，您将能够自信地与 REST API 打交道。

REST API 简介

REST API 是一组规则和约定，用于定义如何以结构化的方式交换请求和响应。它基于 REST 原则，这是一种用于设计网络应用程序的软件架构风格。RESTful API 是遵循 REST 原则的 API 的另一种称呼。

以下是 REST API 遵循的几个 RESTful 规则和约定示例：

客户端-服务器：将用户界面（客户端）与数据存储（服务器）分离。
无状态：每个请求都必须包含完成请求所需的所有信息，服务器不会存储任何上下文信息。

REST API 通常使用 HTTP（超文本传输协议）作为客户端（如 Web 浏览器或移动应用程序）与服务器之间的通信基础。理解 HTTP 及其组件是掌握 REST API 的关键。

API 请求

当您向 API 请求由以下几个主要组件组成：

1. API 端点

端点是 API 的访问点，通常表示为 URL（统一资源定位符）。它由“基本 URL”和“路径”组成，用于指向特定的服务或资源。

API 基本 URL 和路径示例

2. HTTP 方法

HTTP 方法定义了与 API 交互时可以执行的操作。以下是最常用的 4 种方法：

GET：用于请求数据，例如获取某个城市的天气信息。
POST：用于提交数据，例如创建新用户或添加评论。
PUT：用于更新现有数据，例如修改个人资料信息。
DELETE：用于删除数据，例如删除帖子或账户。

尽管所有 4 种方法都可能被使用，但 GET 和 POST 是最常见的两种方法。

3. 请求标头

请求标头包含有关 API 请求的附加信息，例如响应格式、身份验证凭据和缓存指令等。

以下是一个请求标头的示例：

Accept-Language: en-US

Authorization: Bearer YourAccessTokenHere

Content-Type: application/json

Host: www.amazon.com

Origin: https://www.amazon.com

Referer: https://www.amazon.com

User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/117.0.0.0 Safari/537.36

请求标头的常见用途包括：

身份验证：通过 API 密钥或 OAuth 令牌验证用户身份。
缓存指令：提高性能，通过缓存减少重复请求。
日志记录：记录请求的来源、时间等信息，用于调试和监控。

4. 请求正文

请求正文包含发送到 API 的实际数据，通常以 JSON 格式表示。例如，以下是向亚马逊 API 添加新产品的请求正文示例：

POST https://api.amazon.com/products

{

  "product_name": "Smartphone",

  "price": 499.99,

  "description": "A high-quality smartphone with advanced features.",

  "category": "Electronics",

  "availability": true

}

API 响应

当您发送 API 请求后，服务器会返回一个响应，其中包含您请求的数据以及响应的元信息。API 响应由以下几个部分组成：

1. 状态码

状态码是一个三位数的数字，用于指示请求的结果。以下是常见的状态码分类：

2xx 成功：请求成功，例如 200（OK）和 201（Created）。
3xx 重定向：请求需要进一步操作，例如 301（永久重定向）。
4xx 客户端错误：请求有误，例如 400（错误请求）和 401（未授权）。
5xx 服务器错误：服务器发生错误，例如 500（内部服务器错误）。

常见 API 状态码

2. 响应标头

响应标头提供有关响应的附加信息，例如数据类型、服务器版本等。以下是一个示例：

Access-Control-Allow-Origin: www.amazon.com

Content-Length: 22

Content-Type: application/json

Date: Mon, 30 Oct 2023 16:32:01 GMT

3. 响应正文

响应正文包含实际返回的数据，通常以 JSON 格式表示。例如，以下是一个成功添加产品的响应示例：

200 OK

{

  "product_id": 12345,

  "message": "Product 'Smartphone' has been successfully added."

}

总结

通过本篇文章，您已经了解了 REST API 的基本组成部分，包括 API 请求和响应的关键组件。这些知识将帮助您更好地与 API 进行交互和调试。

REST API 模型

在下一部分中，我们将结合实际场景，展示如何应用这些知识进行 API 调试和错误处理。

原文链接: https://www.skiplevel.co/blog/part-2-rest-api-components-how-to-read-them