链接和嵌入
WP REST API 在整个 API 中包含超链接,以实现可发现性和可浏览性,以及将相关资源嵌入到一个响应中。虽然 REST API 不完全符合整个HAL 标准,但它实现了该标准的._links
和._embedded
属性,如下所述。
链接
响应对象的属性_links
包含指向其他 API 资源的链接映射,按“关系”分组。该关系指定链接资源与主要资源的关系。(示例包括“作者”,描述资源与其作者之间的关系,或“wp:term”,描述帖子与其标签或类别之间的关系。)该关系要么是标准化关系,要么是 URI 关系(如https://api.w.org/term
) or a Compact URI relation (likewp:term
). (Compact URI relations can be normalised to full URI relations to ensure full compatibility if required.) This is similar to HTML``tags, or\
链接。
链接是一个对象,包含一个href
属性,该属性具有指向资源的绝对 URL,以及其他可选属性。这些包括内容类型、消歧信息和有关可通过链接执行的操作的数据。
对于集合响应(那些返回对象列表而不是顶级对象的响应),每个项目都包含链接,而顶级响应包括通过标题的链接Link
。
笔记:
如果您的客户端库不允许访问标头,您可以使用该_envelope
参数将标头包含为正文数据。
示例响应
一个典型的单个 post 请求 ( /wp/v2/posts/42
):
{
"id": 42,
"_links": {
"collection": [
{
"href": "https://example.com/wp-json/wp/v2/posts"
}
],
"author": [
{
"href": "https://example.com/wp-json/wp/v2/users/1",
"embeddable": true
}
]
}
}
嵌入
可选地,一些链接的资源可以包含在响应中以减少所需的 HTTP 请求的数量。这些资源被“嵌入”到主要响应中。
嵌入是通过在请求中设置_embed
查询参数来触发的。然后,这将包括_embedded
与键相邻的键下的嵌入式资源_links
。该对象的布局反映了该_links
对象,但包括嵌入资源以代替链接属性。
embeddable
只有标志设置为 的链接true
才能被嵌入,并且_embed
会导致所有可嵌入的链接被嵌入。只有包含嵌入式响应的关系包含在 中_embedded
,但是与混合的可嵌入和不可嵌入链接的关系将包含不可嵌入链接的虚拟响应,以确保数字索引与_links
.
例如,嵌入集合响应时/wp/v2/posts?author=1
,嵌入的集合将应用默认分页限制。
示例响应
{
"id": 42,
"_links": {
"collection": [
{
"href": "https://example.com/wp-json/wp/v2/posts"
}
],
"author": [
{
"href": "https://example.com/wp-json/wp/v2/users/1",
"embeddable": true
}
]
},
"_embedded": {
"author": {
"id": 1,
"name": "admin",
"description": "Site administrator"
}
}
}