获取数据的WP REST API

在本系列的前面部分中，我们一直在研究什么是 wp rest api 以及它如何帮助我们使用 wordpress 后端构建更好的应用程序。

然后，我们研究了在服务器上设置身份验证以生成经过身份验证的请求的两种不同方法。第一种是基本身份验证方法，它在开发环境中很有用，并且允许快速原型设计，因为它不需要太多时间来设置。高级身份验证方法是 OAuth 2.0，推荐用于生产环境，因为它比基本身份验证方法安全得多。

现在我们已经了解了如何设置身份验证，我们准备生成经过身份验证的请求以释放 WP REST API 的全部功能。由于其易于使用，我们将在本系列中使用基本身份验证，但建议您为生产服务器使用 OAuth 2.0 身份验证（由 WordPress REST API 身份验证插件提供）。

WordPress REST API 身份验证插件通过添加身份验证机制来控制对 API 端点的访问，从而增强了 WordPress REST API 的安全性。它带有一些身份验证方法：

• 基本身份验证
• API 密钥身份验证
• JWT 身份验证
• OAuth 2.0 身份验证

设置身份验证后，您可以为不同的 API 端点定义访问控制规则。它允许您配置哪些用户或角色有权访问特定端点。它还提供了根据用户角色、能力或特定用户 ID 限制访问的选项。

在本系列的当前部分中，我们将首次亲身体验 WP REST API。我们将：

• 分析 GET 请求的结构
• 查看 OPTIONS 请求如何自行记录 API
• 向服务器发送请求以检索数据
• 分析包括属性、架构和链接的服务器响应

因此，我们首先分析一个简单的 GET 请求的结构。

GET 请求剖析

在深入研究使用 WP REST API 检索任何数据的详细信息之前，我们需要熟悉发送到服务器的请求的语法。这将为我们将来与 WP REST API 的交互奠定坚实的基础。

考虑发送到服务器的以下请求：

$GET https://localserver/wp-json/wp/v2/posts

我们发送的请求类型是 GET — 我们在本系列的第一部分中介绍的六个 HTTP 动词之一。 GET 请求用于从服务器检索数据。因此，当在服务器上执行时，上述请求会以 JSON 数据的形式检索所有 post 对象的集合。

考虑到请求 URI，我们可以将其分为以下部分：

• https://localserver/：我的本地开发服务器的 URL。它可以是任何 URL，具体取决于您的 WordPress 安装位置。
• /wp-json：WP REST API 的端点前缀。
• /wp：WP REST API 的命名空间。
• /v2：WP REST API 的版本。
• /posts：这是我们要从服务器检索的资源。

命名空间可防止运行多个插件时可能发生的覆盖，每个插件都为 RESTful API 提供自己的抽象层。因此，每个抽象都在自己的边界内工作，不会影响属于其他抽象的方法和属性。

除了使用上述 URI 检索资源（帖子）集合之外，我们还可以通过提及其 ID 来检索特定资源：

$GET /wp/v2/posts/100

上面的请求将返回一个 post 对象，因为它向下查找 ID 为 100 的 post 资源。

通常，我们还需要搜索符合某些特定条件的帖子。例如，您可以按类别过滤帖子，如以下代码片段所示。

$ GET /wp/v2/posts?categories=20,30

通过发送上述请求，我们可以检索属于 ID 20 和 30 的类别的所有帖子。如您所见，您可以在 categories 参数中传递一个或多个类别 ID，它应该返回帖子在类别分类中分配特定术语。

上述语法相当于以下 WP_Query() 调用：

<?php
$query = new WP_Query( array(
    'tax_query' => array(
        array(
            'taxonomy' => 'category',
            'field'    => 'term_id',
            'terms'    => array( 20, 30 ),
        ),
    ),
) );

因此，上述 GET 请求将检索属于 ID 为 20 和 30 的两个类别的帖子列表。相同的语法也可用于具有两个以上元素的数组参数.

现在我们已经了解了如何格式化 GET 请求并提供其参数，是时候看看 OPTIONS 请求了。 OPTIONS 请求可以轻松地浏览 API，并且实际上可以作为一种自记录方式，通过记录端点上所有可用的 HTTP 方法以及参数来使 API 更易于访问他们支持。

使用 OPTIONS 请求在 API 中导航

如前所述，OPTIONS 请求对于探索 API 非常有帮助。它提到了属于某个路由的所有端点，并提供了这些端点支持 CRUD 操作的参数列表。

让我们向 /wp/v2/posts 路由发送 OPTIONS 请求，以检查它支持哪些端点以及我们可以沿 GET请求查询数据：

$curl -X OPTIONS /wp/v2/posts

我使用curl发送上述请求，但您可以使用您选择的任何工具，包括Postman。请务必包含上述路由的完整路径，包括您的服务器的路径。

{
    "namespace": "wp/v2",
    "methods": [...],
    "endpoints": [...],
    "schema": {...},
    "_links": {...}
}

上面的 OPTIONS 请求 /wp/v2/posts 路由返回 JSON 格式的数据，其中包含五个属性：

• 命名空间
• 方法
• 端点
• schema
• _links

{
    "namespace": "wp/v2",
    ....
}

namespace 属性标识当前插件的命名空间。在我们的例子中，它是 wp/v2，表示 WP REST API 的版本 2。我们已经在上一节中了解了命名空间及其服务的用途。

{
    ...
    "methods": [
        "GET",
        "POST"
    ],
    ...
}

methods 属性包含当前路由支持的所有方法的数组。通过查看上述请求返回的响应，可以清楚地看到 /wp/v2/posts 路由支持两种方法，即 GET 和 POST 。这意味着我们可以使用 /wp/v2/posts 路由来检索帖子，以及创建新帖子。我们将在本系列的下一部分中处理 POST 方法，因此我们暂时只关注 GET 方法。

下一个属性 — endpoints — 包含当前路由支持的端点数组。此属性直接链接到前面提到的 methods 属性，因为它列出了支持的方法的端点。

{
    ...
    "endpoints": [
        {
            "methods": [
                "GET"
            ],
            "args": {...},
            "allow_batch": {"v1":true}
        },
        {
            "methods": [
                "POST"
            ],
            "args": {...},
            "allow_batch": {"v1":true}
        }
    ],
    ...
}

endpoints 属性包含对象值，而对象值又包含三个属性，即 methods、args 和 allow_batch。 methods 属性包含 HTTP 方法的数组，下一个 args 属性包含这些方法支持的所有参数。最后，allow_batch 属性用于了解端点是否支持批量请求功能。这些是我们以 URI 参数的形式随请求发送的参数。

查看 GET 方法支持的参数，我们发现了 20 多个参数，包括 context、page、

"methods": [
        "GET"
],
"args": {
    "context": {
        "required": false,
        "default": "view",
        "type": "string",
        "description": "Scope under which the request is made; determines fields present in response."
    },
    "page": {
        "required": false,
        "default": 1,
        "type": "integer",
        "description": "Current page of the collection.",
        "minimum": "1"
    },
    "per_page": {
        "required": false,
        "default": 1,
        "type": "integer",
        "description": "Maximum number of items to be returned in result set.",
        "minimum": "1",
        "maximum": "100"
    },
}

$curl -X GET http://wordpress-server/wp-json

$GET /wp/v2/posts?context=edit

$GET /wp/v2/posts?per_page=5

$GET /wp/v2/posts?per_page=5&page=2

$ GET /wp/v2/posts?modified_after=2015-10-14&modified_before=2015-10-16

$ GET /wp/v2/posts?categories=5,6

$ GET /wp/v2/posts?categories_exclude=5,6

$ GET /wp/v2/posts/10/revisions

$ GET /wp/v2/posts/10/revisions/2

$ GET /wp/v2/categories?post=<post_id>

$ GET /wp/v2/tags?post=<post_id>

$ GET /wp/v2/posts/10/meta