什么是 REST API？

REST API（表述性状态传输应用程序编程接口）是一组允许不同软件系统通过互联网进行通信的规则。将 API 想象为连接两个系统的桥梁，允许它们请求和共享信息。

让我们分解一下 REST API 的组件：

• API（应用程序编程接口） ：API 就像餐厅的菜单。它提供客户端可以请求的操作列表，服务器（如厨师）执行这些操作并返回响应。
• REST（表述性状态传输） ：REST 是一组使用 GET、POST、PUT 和 DELETE 等标准操作构建通过 HTTP 运行的 Web 服务的指南。

REST API 如何工作？

REST API 允许客户端（例如您的浏览器或应用程序）向服务器发送请求并接收返回的数据。让我们逐步分解它是如何工作的：

1. 客户端请求：客户端（您的应用程序）向服务器上的特定 URL 发送 HTTP 请求。该URL代表资源（例如，用户、产品等）。
   • 示例： GET https://api.example.com/users请求用户列表。
2. 服务器处理：服务器接收请求，处理请求，检索数据（通常从数据库），并准备响应。
3. 服务器响应：服务器将 HTTP 响应发送回客户端。该回应包括：
   • 状态代码：指示请求是否成功（例如，200 OK 表示成功，404 Not Found 如果资源不存在）。
   • Data ：通常为 JSON 格式，表示请求的资源。

基本身份验证：它是什么以及为什么它很重要？

基本身份验证是用户在请求 API 时验证其身份的简单方法。在此方法中，客户端发送在请求标头中编码的用户名和密码，然后服务器对其进行验证。

为什么它很重要？ ：身份验证确保只有授权用户才能访问资源，防止未经授权的用户获得访问权限。

它是如何运作的？ ：当客户端向服务器发送请求时，它会包含一个Authorization标头，其中包含以 Base64 编码的凭据。

 例子：

Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=

服务器解码此标头并检查用户名和密码是否有效。

WordPress REST API 的身份验证方法

使用WordPress REST API时，可以使用多种身份验证方法来保护请求：

 1：基本认证

• 这种方法经常用于测试和简单的应用。您在请求标头中发送您的 WordPress 用户名和密码。
• 插件提示：要在 WordPress 中使用基本身份验证，您可以使用基本身份验证插件。出于安全考虑，不建议在生产环境中使用此方法。

 2：Cookie认证

• 当您希望当前登录的用户访问API时，可以使用Cookie认证。当用户登录 WordPress 时，会创建一个会话 cookie，并且 API 使用此 cookie 对用户进行身份验证。
• 用例：这通常用于与 WordPress 站点在同一域上运行的前端 JavaScript 应用程序。

 3：OAuth认证

• OAuth 是一种更安全的方法，允许第三方应用程序代表用户访问 WordPress REST API，而无需共享其密码。
• 插件示例：您可以使用 WordPress 的 OAuth 1.0a 服务器插件来实现基于 OAuth 的身份验证。

 4：申请密码

• WordPress 还支持应用程序密码，这是用于 API 访问的唯一密码。您可以在 WordPress 仪表板中生成应用程序密码，这些密码可用于身份验证。
• 如何生成：转到 WordPress 中的用户个人资料，向下滚动到应用程序密码部分，然后生成新密码。

使用 WordPress REST API 最大化开发

WordPress REST API 允许您从 WordPress 仪表板外部与 WordPress 网站进行交互，从而可以创建功能强大的 Web 应用程序。以下是如何最大化发展：

1：自定义端点：您可以创建自定义端点以公开 WordPress 站点中默认情况下可能不可用的其他数据。

• 如何创建：使用 WordPress 主题或插件中的register_rest_route()函数来添加新端点。

例子：

add_action('rest_api_init', function() {
  register_rest_route('myplugin/v1', '/custom-data/', array(
    'methods' => 'GET',
    'callback' => 'my_custom_data_callback',
  ));
});

function my_custom_data_callback() {
  return new WP_REST_Response(array('data' => 'Hello, world!'), 200);
}

2：JavaScript集成：使用JavaScript向REST API发送请求，以创建动态、交互式的用户体验。例如，您可以构建一个 React 或 Vue.js 应用程序，通过 REST API 与 WordPress 后端交互。

实际示例：想象一下构建一个自定义评论系统，用户可以在其中发布评论而无需重新加载页面，所有这一切都是通过 JavaScript 与 REST API 进行交互。

使用 JavaScript 发送经过身份验证的请求

要使用 JavaScript 发送经过身份验证的请求，您必须在请求标头中包含正确的凭据或令牌。例如：

fetch('https://api.example.com/users', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic ' + btoa('username:password'),
    'Content-Type': 'application/json'
  }
})
  .then(response => response.json())
  .then(data => console.log(data));

在此示例中，btoa() 函数将凭证编码为 Base64 以进行主要身份验证。

 Cookie 认证

使用 cookie 身份验证时，您可以使用 WordPress 登录用户的会话 cookie 来访问 REST API。以下是其工作原理的分步示例：

1. 用户登录用户登录到您的 WordPress 站点，WordPress 会在用户的浏览器中设置身份验证 cookie。
2. 发送请求：当您的 JavaScript 代码请求 REST API 时，浏览器会在请求标头中包含 cookie，并且 WordPress 知道哪个用户正在发出请求。

使用 WordPress HTTP API 发送请求

您还可以使用WordPress HTTP API从 WordPress 站点内发送请求。 HTTP API 是 WordPress 提供的一组用于与 REST API 交互的函数。

发送 GET 请求的示例：

$response = wp_remote_get('https://api.example.com/users');
if (is_wp_error($response)) {
  $error_message = $response->get_error_message();
  echo "Something went wrong: $error_message";
} else {
  $body = wp_remote_retrieve_body($response);
  echo $body;
}

此示例使用 wp_remote_get() 函数将 GET 请求发送到外部 API 并检索响应。

 概括

在本指南中，我们介绍了：

• 什么是 REST API？它如何允许不同系统进行通信？
• REST API 的工作原理，包括如何发出和处理请求。
• 身份验证方法，例如基本身份验证、cookie 身份验证、OAuth 和应用程序密码，以及它们为何必不可少。
• WordPress REST API 身份验证，包括如何使用 JavaScript 和 PHP 发送经过身份验证的请求。

常见问题解答：有关 REST API 和身份验证的常见问题

1. 我可以在没有身份验证的情况下使用 REST API 吗？
   • 是的，但仅限于公共数据。对于任何敏感数据，您需要适当的身份验证。
2. 基本身份验证安全吗？
   • 基本身份验证对于生产来说并不安全，因为凭据是编码的，而不是加密的。它更适合测试或通过 HTTPS。
3. 应用程序密码有什么用？
   • 应用程序密码可验证 API 请求，而无需共享您的主要 WordPress 密码。它们帮助集成第三方应用程序。

 下一步

• 练习身份验证：尝试在本地 WordPress 站点中实施不同的身份验证方法。
• 创建自定义端点：尝试在 WordPress 中创建自定义端点以扩展 REST API 的功能。
• JavaScript 和 PHP 集成：练习使用 JavaScript（如 fetch）和 PHP（使用 WordPress HTTP API）发送请求。
• 使用 Postman 进行测试：使用Postman等工具来测试您的 REST API 端点并练习发送经过身份验证的请求。

快乐编码，继续探索！ REST API 是一个强大的工具，了解如何使用它将为 Web 开发带来无限的可能性。