WordPress REST API手册(二):关键概念

在本页中,我们将分解与 REST API 相关的一些关键概念和术语:Routes & Endpoints、 RequestsResponsesSchemaController Classes。这些概念中的每一个都在理解、使用和扩展 WordPress REST API 方面发挥着至关重要的作用,并且在本手册中对每一个都进行了更深入的探讨。

Routes & Endpoints

在 WordPress REST API 的上下文中,路由是可以映射到不同 HTTP 方法的 URI。单个 HTTP 方法到路由的映射称为端点

例如,如果我们GET向 URI 发出请求,http://oursite.com/wp-json/我们会返回一个 JSON 响应,显示哪些路由可用,以及每个路由中哪些端点可用。/wp-json/是一条路由,当该路由接收到GET请求时,该请求由端点处理,该端点显示所谓的 WordPress REST API 索引。相比之下,路由wp-json/wp/v2/posts有一个GET返回帖子列表的端点,还有一个POST接受经过身份验证的请求以创建新帖子的端点。

我们将在以下部分学习如何注册我们自己的路由和端点。

如果您404在尝试访问时遇到错误http://oursite.com/wp-json/,请考虑启用漂亮的永久链接或尝试改用该rest_route参数。

Requests

REST API 请求在 WordPress 中由该类的实例表示,WP_REST_Request该类用于存储和检索当前请求的信息。WP_REST_Request当您向已注册的 API 路由发出 HTTP 请求时,会自动生成一个对象。此对象中指定的数据(源自路由 URI 或作为请求的一部分发送的 JSON 有效负载)决定了您将从 API 中获得的响应。

请求通常通过 HTTP 远程提交,但也可以通过 WordPress 插件或主题代码中的 PHP 在内部进行。使用这个类你可以做很多简洁的事情,在手册的其他地方有更详细的描述。

Responses

响应是您从 API 返回的数据。该类WP_REST_Response提供了一种与端点返回的响应数据进行交互的方法。响应返回请求的数据,或者如果在完成请求时出现问题,也可以用于返回错误。

Schema

每个端点都需要特定结构的输入数据,并使用已定义且可预测的结构返回数据。这些数据结构在 API Schema 中定义。模式构建 API 数据并提供 API 可以返回的所有属性以及它可以接受的输入参数的完整列表。定义良好的模式还在 API 中提供了一层安全性,因为它使我们能够验证和清理对 API 发出的请求。Schema 部分进一步探讨了这个大主题。

控制器类Controller Classes

控制器类在 REST API 响应周期内统一和协调所有这些不同的移动部分。使用控制器类,您可以管理路由和端点的注册、处理请求、利用模式和生成 API 响应。单个类通常包含给定路由的所有逻辑,给定路由通常代表 WordPress 站点中特定类型的数据对象(如自定义帖子类型或分类法)。


《WordPress REST API手册》完整目录:

THE END
评论 抢沙发
头像
欢迎您留下宝贵的见解!
提交
头像

昵称

取消
昵称表情代码图片