WordPress中文开发手册

链接和嵌入

WP REST API在整个API中集成了超链接,以允许可发现性和可浏览性,并在一个响应中嵌入相关资源。虽然REST API不完全符合整个HAL标准,但是它将按照下面的描述从该标准中实现._links和._embedded属性。

##链接

响应对象的_links属性包含指向其他API资源的链接映射,按“关系”分组。该关系指定链接资源与主资源的关联。 (例子包括描述资源及其作者之间的关系的“作者”,或描述一个帖子与其标签或类别之间的关系的“wp:term”)。关系是标准化关系,URI关系https://api.w.org/term)或紧凑的URI关系(如wp:term)。 (紧凑型URI关系可以归一化为完全的URI关系,以确保完全兼容性,如果需要)。这与HTML<link>标签或<a rel="">链接类似。

链接是包含href属性的对象,其中包含资源的绝对URL,以及其他可选属性。这些包括内容类型,消歧信息以及可以通过链接采取的操作的数据。

对于收集响应(返回对象列表而不是顶级对象的响应),每个项目都包含链接,顶层响应包含通过链接头的链接。

注意:如果您的客户端库不允许访问标题,可以使用_envelope参数将标题作为正文数据。

响应示例

典型的单一帖子请求(/ wp / v2 / posts / 42):

{
  "id": 42,
  "_links": {
    "collection": [
      {
        "href": "https://demo.wp-api.org/wp-json/wp/v2/posts"
      }
    ],
    "author": [
      {
        "href": "https://demo.wp-api.org/wp-json/wp/v2/users/1",
        "embeddable": true
      }
    ]
  }
}

嵌入

可选地,一些链接的资源可以包括在响应中以减少所需的HTTP请求的数量。 这些资源被“嵌入”为主要响应。

通过在请求上设置_embed查询参数来触发嵌入。 然后,这将包括与_links键相邻的_embedded键下的嵌入资源。 此对象的布局反映_links对象,但包含嵌入式资源代替链接属性。

只有嵌入标志设置为true的链接才能被嵌入,并且_embed将导致嵌入所有嵌入式链接。 只有包含嵌入式响应的关系才包含在_embedded中,然而与混合嵌入式和不可嵌入链接的关系将包含用于不可嵌入链接的虚拟响应,以确保数字索引与_links中的匹配。

响应示例

{
  "id": 42,
  "_links": {
    "collection": [
      {
        "href": "https://demo.wp-api.org/wp-json/wp/v2/posts"
      }
    ],
    "author": [
      {
        "href": "https://demo.wp-api.org/wp-json/wp/v2/users/1",
        "embeddable": true
      }
    ]
  },
  "_embedded": {
    "author": {
      "id": 1,
      "name": "admin",
      "description": "Site administrator"
    }
  }
}