WordPress REST API:它是什么以及如何开始使用它

如果您在过去几年中在WordPress社区中度过了任何时间,那么您很有可能听说过对新REST API的参考。但是,除非您是经验丰富的开发人员,否则您可能不知道WordPress REST API的实际含义。

尽管技术细节有些复杂,但是此功能背后的基本概念很容易掌握。新的API有助于扩展WordPress作为平台的功能。而且,REST API使开发人员将WordPress与其他站点和应用程序连接起来比以往更加简单。

wordpress-rest-api
#WordPress #REST API:它是什么以及如何开始使用它
点击鸣叫 

 

在本综合指南中,我们将引导您完成所有需要了解的基础知识。我们将解释一般的API,特别是REST API(以及WordPress特定版本)。然后,我们将讨论如何自己开始使用WordPress REST API。让我们跳进去吧!

应用程序编程接口(API)简介

在我们专门研究REST API之前,让我们先备份一下。要理解这个概念,关键是首先要了解一般的API。

在最基本的级别上,API(或应用程序编程接口)使两个应用程序能够相互通信。例如,当您访问网站时,浏览器将请求发送到该网站所在的服务器。该服务器的API接收浏览器的请求,对其进行解释,然后发送回所有显示您的站点所需的数据。

当然,从技术角度来看,API的工作方式还有很多。但是,我们将专注于对您来说最重要的事情-实际应用。由于许多公司已经开始将API打包并将其提供为您可以使用的产品,因此API受到了越来越多的关注和可见性。

换句话说,像Google这样的公司的开发人员将一起收集其应用程序代码的某些部分,并将其公开发布。这样,其他开发人员就可以使用API​​作为工具来帮助自己的网站连接到Google并利用其功能:

google-api-library

例如,您可以使用Google Maps API 在您的网站上放置功能齐全的地图,该地图将受益于Google的所有相关数据和功能。这使您不必编写地图并自己收集所有数据。这同样适用于广泛的站点和应用程序。

随着网站及其所依赖的功能变得越来越复杂,诸如API之类的工具变得至关重要。它们使开发人员可以利用现有功能,从而可以简单地将新功能“插入”到您的网站中。反过来,拥有API的站点会从增加的展示次数和流量中受益。

REST(代表性状态转移)API的基本规则

有多种创建API的方法。一个REST(表述性状态转移)API是下面的具体规则开发的特殊类型。换句话说,REST提供了一组开发人员在构建API时可以使用的准则。这样可以确保API有效运行。

因此,要了解REST API的工作原理,您需要知道它们遵循的规则(或“约束”)。使API成为RESTful的五个基本元素。请记住,“服务器”是API所属的平台,“客户端”是连接到该平台的站点,应用程序或软件:

RESTful-2
  1. 客户端-服务器体系结构。应当构建API,以便客户端和服务器保持彼此独立。这样,他们就可以继续自己发展,并且可以独立使用。
  2. 无国籍状态。REST API必须遵循“无状态”协议。换句话说,他们无法在服务器上存储有关客户端的任何信息。客户的请求应包括所有必要的前期数据,响应应提供客户所需的一切。这使每次交互成为“一劳永逸”的交易,并减少了内存需求和潜在的错误。
  3. 可缓存性。 “缓存”是特定数据的临时存储,因此可以更快地检索和发送。RESTful API尽可能使用可缓存的数据,以提高速度和效率。另外,API需要让客户端知道每条数据是否可以并且应该被缓存
  4. 分层系统。精心设计的REST API是使用层构建的,每个层都有其自己的指定功能。这些层相互作用,但保持分离。这使API易于随时间进行修改和更新,并提高了其安全性
  5. 统一的界面。REST API的所有部分都需要通过相同的接口运行,并使用相同的语言进行通信。该接口应专门为API设计,并能够自行发展。它不应依赖于服务器或客户端来起作用。

遵循这些原则的任何API都可以视为RESTful。有也第六约束,被称为“按需代码”。当遵循该技术时,该技术可使API指示服务器将代码传输给客户端,以扩展其功能。但是,此约束是可选的,并非所有REST API都采用。

WordPress REST API

在这一点上,您可能想知道所有这些因素如何影响您。API是出色的工具,但是它们与您的日常工作相关吗?如果您是WordPress用户,答案肯定是“是”。

WordPress REST API已经开发了两年了。相当长一段时间以来,它都是作为一个独立的插件进行开发的,开发人员可以随着时间的推移为之做出贡献,任何人都可以尝试使用。

实际上,REST API插件有两个单独的版本。该API的元素早在更新4.4中就已添加到核心平台中。然后是WordPress 4.7(2016年)完全集成。这意味着,今天,WordPress具有自己的功能齐全的REST API。

平台为什么要采取这一举措?根据项目站点本身,这是因为WordPress正朝着成为“成熟的应用程序框架”迈进。换句话说,REST API使平台可以与几乎任何站点和Web应用程序进行交互。另外,无论外部程序使用哪种语言,它都可以通信和交换数据。

rest-api

为开发人员打开了许多可能性。它还使WordPress作为一个比以往更灵活,更通用的平台。正如Barn2 Media的运营总监Katie Keith 所说:

通过了解REST API,WordPress开发人员可以选择最有效的方式来执行每个任务,而不必局限于特定的技术或平台,例如PHP或WordPress后端。REST API得到有效利用,使第三方集成更加容易……它甚至带来了新的机遇,例如创建自己的基于WordPress的移动应用程序,或探索与WordPress进行通信的独特新方法。

同样重要的是要注意,您可能会听到有时称为WordPress JSON REST API的此功能。“ JSON”部分代表JavaScript对象表示法,描述了此API用来交换数据的格式。该格式基于JavaScript,并且由于与许多常见编程语言的良好接口而成为开发API的一种流行方式。换句话说,JSON API能够更轻松地促进利用不同语言的应用程序之间的通信。

WordPress REST API请求的剖析

您现在应该了解WordPress REST API的总体目的和方向。因此,让我们详细介绍一下它是如何工作的。如果您想动手操作并自己开始尝试API,则需要了解一些基本概念。

如前所述,每个API都会处理请求并返回响应。换句话说,客户端要求其执行特定操作,然后API会执行该操作。API的确切执行方式可能有所不同。REST API是专门设计用来使用简单的HTML命令(或“方法”)来接收和响应特定类型的请求的。

为了说明这一点,下面是客户端可以发送的最基本和最重要的HTML方法:

HTML-methods-1
  • GET:此命令从服务器检索资源(例如特定数据)。
  • POST:这样,客户端将资源添加到服务器。
  • PUT:您可以使用它来编辑或更新服务器上已经存在的资源。
  • 删除:顾名思义,这将从服务器中删除资源。

客户端将与这些命令一起发送一条或多条线,以准确传达所需的资源以及应使用的资源。例如,将PHP文件上传到服务器上特定文件夹的请求可能如下所示:

POST /foldername/my_file.php

/foldername/my_file.php部分被称为“路线”,因为它告诉API去哪里,什么样的数据与互动。当您将其与HTTP方法(在这种情况下为POST)结合使用时,整个功能称为“端点”。

大多数REST API和与其交互的客户端要比这复杂得多-包括WordPress版本。但是,这些基本元素构成了WordPress REST API如何工作的基础。

如何开始使用WordPress REST API

只要您建立了WordPress网站,就可以立即开始尝试REST API。您只需执行浏览器即可执行各种GET请求以直接检索数据。

要访问WordPress REST API,您需要从以下路径开始:

yoursite.com/wp-json/wp/v2

然后,您可以添加到该URL上以访问各种类型的数据。例如,您可以通过以下路径查找特定的用户个人资料:

yoursite.com/wp-json/wp/v2/users/4567

在这种情况下,“ 4567”是您要查看的配置文件的唯一用户ID。如果您省略了该ID,则会看到您网站上所有用户的列表:

rest-api-user-list

您可以使用相同的基本路线来查看其他类型的数据,例如帖子或页面。您甚至可以搜索符合特定条件的数据子集。例如,您可以使用以下URL检索包含特定术语的所有帖子:

yoursite.com/wp-json/wp/v2/posts?=search [关键字]

当然,这只是一个简单的例子。使用WordPress REST API可以实际执行的操作几乎没有限制。如果您想了解有关其工作原理的更多信息,建议从以下资源开始:

  • REST API手册这是官方的WordPress资源,记录了有关REST API的各种信息。除其他事项外,您将找到可以使用的端点列表,以及在此未涉及的REST API的某些结构方面的详细信息。
  • W3Schools教程尽管此资源不是特定于REST API的,但它提供了方便的教程,可以帮助您熟悉关键概念,例如 HTTP方法 JSON
  • WordPress REST API终极指南。 这本来自WP Engine的免费电子书包含许多实用信息和示例。另外,它将引导您完成一些基本(以及更高级)的任务。
  • 在此期间,还请查看WordPress开发人员十大插件列表。在您探索REST API的世界时,它们一定会派上用场。

WordPress REST API无疑是一个复杂的话题。但是,即使对于非开发人员,也有必要了解该技术如何工作以及如何实现的基础知识。而且,它甚至可以使您自己开始涉足开发!

到顶部

结论

没有比现在更好的时间来学习WordPress REST API。由于已完全合并到WordPress核心中,因此它将在平台的未来中扮演重要角色。各行各业的开发人员将使用此API以以前难以或不可能的方式将WordPress连接到更广泛的网络。

自己理解这个概念可能会有些挑战。但是,从根本上讲,这些概念很容易掌握。REST API是一个接口,使两个程序可以彼此“交谈”,并且是根据确保其灵活,可扩展和安全的准则创建的。如果您想更深入地研究所有这些工作原理以及如何使用它们,那么这里有很多有用的资源,例如官方手册

Total
0
Shares
相关文章