使用WordPressRESTAPI创建简单Web应用及RESTAPI的深入解析

# 使用WordPress REST API创建简单Web应用及REST API的深入解析 ## 1. 使用WordPress REST API创建简单Web应用 ### 1.1 数据处理与认证 在使用`jQuery.ajax()`方法时，传递到`data`属性的数据会被处理成查询字符串。为了防止数据传递到jQuery的`data`属性中，同时避免`application/x-www-form-urlencoded`作为默认内容类型发送到服务器，我们将`ContentType`和`processData`属性都设置为`false`。由于需要对具有`edit_posts`权限的用户进行认证，因此要设置`Authorization`头部。 ### 1.2 删除数据 WP REST API在删除数据时非常简单，只需发送一个`DELETE`请求到特定资源即可。例如，要删除一个具有唯一ID的帖子，可以发送如下请求： ```plaintext $ DELETE /wp/v2/posts/100?force=true ``` 这个请求会永久删除该帖子，而不是将其放入回收站。`force`参数决定了是否永久删除，如果从上述请求中移除`force`参数，帖子将被发送到回收站，而不是永久删除。 ### 1.3 WP REST API的内部类和方法 WP REST API主要有两类类：端点类和基础设施类。 - **端点类**：负责执行创建、读取、更新和删除等操作，包括不同的控制器，如`WP_REST_Posts_Controller`等，它们都包含在一个更通用的类`WP_REST_Controller`中。这些类有以`_item()`结尾、以CRUD相关操作开头的方法，如`create_item()`。 - **基础设施类**：主要有三个核心类，分别是`WP_REST_SERVER`、`WP_REST_REQUEST`和`WP_REST_RESPONSE`。 - **WP_REST_Server**：用于处理请求、注册路由并准备适当的响应。如果出现错误，它会封装错误消息体和错误代码，并检查是否使用了`Authorization`方法。在本教程中使用的端点是`/wp-on`，它会检查网站的所有功能和允许的路由。在处理请求和响应时，它会相应地使用`WP_Rest_Response`和`WP_REST_Request`。 - **WP_REST_Request**：是WP REST API的对象，包含请求头和请求体的数据。`WP_REST_Server`类会传递这些数据以执行回调函数，并检查设置的参数是否随请求传递，如果需要，会对数据进行清理。 - **WP_REST_Response**：顾名思义，包含响应体和响应状态码等有利和必要的数据。 ### 1.4 修改服务器响应 WP REST API允许更改服务器为每个默认路由返回的数据，但不是所有数据（如页面、帖子、用户等）都能始终适应这些更改。在进行更改时，开发者应谨慎考虑，因为更改响应中的字段或删除默认字段可能会导致客户端的兼容性问题。鼓励为服务器返回的多个或单个对象的响应添加字段。 `register_rest_field()`方法用于在服务器返回的响应中添加或更新字段，它接受三个主要参数： - `$object_type`：可以是字符串或数组，包含要添加字段的所有对象的名称，适用于为自定义帖子类型添加自定义字段。 - `$attribute`：在服务器发送响应时以键的形式出现。 - `$args`：包含另外三个键，分别是`$get_callback`、`$update_callback`和`$schema`。前两个键用于在需要接收自定义字段值的更新时使用，而`$schema`键用于提供自定义字段的定义。这些键不是必需的，但如果缺少它们，相应的功能将无法添加。该方法会修改`$wp_rest_additional_fields`变量，该数组会按对象类型保存注册的字段，并通过服务器的响应返回。每当使用上述方法注册新字段时，`$wp_rest_additional_fields`变量就会更新。 下面是一个简单的流程图，展示了使用`register_rest_field()`方法的流程： ```mermaid graph TD; A[开始] --> B[设置$object_type]; B --> C[设置$attribute]; C --> D[设置$args]; D --> E[调用register_rest_field()方法]; E --> F[修改$wp_rest_additional_fields变量]; F --> G[服务器返回 ```