WordPress中文开发手册

  1. Home
  2. Docs
  3. WordPress中文开发手册
  4. WordPress REST API手册
  5. 扩展REST API
  6. 词汇表

词汇表

最新的REST API?加快我们文档中使用的短语速度。

控制器

模型 - 视图 - 控制器是软件开发中的标准模式。如果你还不熟悉,你应该做一些阅读来加快速度。

在WP-API中,我们采用了控制器概念,为代表资源端点的类提供了标准模式。所有资源端点扩展WP_REST_Controller以确保它们实现常用方法。

HEAD,GET,POST,PUT和DELETE请求

这些“HTTP动词”表示HTTP客户端可能对资源执行的操作的类型。例如,GET请求用于获取帖子的数据,而DELETE请求用于删除帖子。它们被统称为“HTTP动词”,因为它们在网络上是标准化的。

如果您熟悉WordPress函数,则GET请求与wp_remote_get()相当,POST请求与wp_remote_post()相同。

HTTP客户端

短语“HTTP Client”是指用于与WP-API进行交互的工具。您可以使用Postman(Chrome)或REST Easy(Firefox)来测试浏览器中的请求,或者使用httpie在命令行中测试请求。

WordPress本身在WP_HTTP类和相关函数(例如wp_remote_get())中提供一个HTTP客户端。这可以用于从另一个访问一个WordPress站点。

Resource

“资源”是WordPress中的离散实体。 您可以将这些资源作为帖子,页面,评论,用户,条款等知道。 WP-API允许HTTP客户端对资源执行CRUD操作(CRUD表示创建,读取,更新和删除)。

务实地,以下是通常与WP-API资源进行交互的方式:

  • GET /wp-json/wp/v2/posts 收集帖子。 这大致相当于使用WP_Query。
  • GET /wp-json/wp/v2/posts/123 获得ID为123的单个帖子。这大致相当于使用get_post()。
  • POST /wp-json/wp/v2/posts 创建一个新的帖子。 这大致相当于使用wp_insert_post()。
  • DELETE /wp-json/wp/v2/posts/123 删除具有ID 123的帖子。这大致相当于wp_delete_post()。

Routes / Endpoints

端点是通过API可用的功能。 这可以是检索API索引,更新帖子或删除注释。 端点执行一个特定的功能,采取一些参数和返回数据到客户端。

路由是您用于访问端点的“名称”,用于URL中。 一个路由可以有多个端点与它相关联,哪个使用取决于HTTP动词。

例如,使用URL http://example.com/wp-json/wp/v2/posts/123:

“route”是wp / v2 / posts / 123 - 路由不包括wp-json,因为wp-json是API本身的基本路径。
该路由有3个端点:

  • GET 触发get_item方法,将后期数据返回给客户端。
  • PUT 触发update_item方法,将数据更新,并返回更新的帖子数据。
  • DELETE 触发delete_item方法,将现在删除的帖子数据返回给客户端。

注意:在没有很多固定链接的站点上,路由替代作为rest_route参数添加到URL中。 对于上述示例,完整的网址将是http://example.com/?rest_route=wp/v2/posts/123

Schema

“模式”是WP-API的响应数据的格式的表示。 例如,Post架构通信请求获取Post将返回id,title,content,author和其他字段。 我们的模式还指出每个字段的类型,提供人类可读的描述,并显示该字段将返回哪些上下文。