WordPress REST API 基于 REST 构建,旨在拥有可预测的、面向资源的 URL,并使用 HTTP 响应代码来指示 API 错误。该 API 利用内置的 HTTP 功能,如 HTTP 认证和 HTTP 动词,这些功能可由现成的 HTTP 客户端理解,并支持跨域资源共享(CORS),允许您从客户端 Web 应用程序安全地与 API 交互。
REST API 完全使用 JSON 作为请求和响应格式,包括错误响应。虽然 REST API 并未完全符合 HAL 标准,但它实现了 HAL 的 ._links 和 ._embedded 属性用于链接 API 资源,并且可以通过响应中的超链接完全发现。
REST API 提供对任何客户端匿名公开的公共数据,以及仅在 认证 后可用的私有数据。一旦认证,REST API 支持大多数内容管理操作,允许您为站点构建替代仪表板,通过更响应灵敏的管理工具增强您的插件,或构建复杂的前端单页应用。
本 API 参考文档提供了关于通过 API 可用的特定端点、它们的参数及其响应数据格式的详细信息。
REST API 开发者端点参考
| 资源 | 基础路由 |
|---|---|
| 文章 | /wp/v2/posts |
| 文章修订版 | /wp/v2/posts/<id>/revisions |
| 分类法 | /wp/v2/categories |
| 标签 | /wp/v2/tags |
| 页面 | /wp/v2/pages |
| 页面修订版 | /wp/v2/pages/<id>/revisions |
| 评论 | /wp/v2/comments |
| 分类法 | /wp/v2/taxonomies |
| 媒体 | /wp/v2/media |
| 用户 | /wp/v2/users |
| 文章类型 | /wp/v2/types |
| 文章状态 | /wp/v2/statuses |
| 设置 | /wp/v2/settings |
| 主题 | /wp/v2/themes |
| 搜索 | /wp/v2/search |
| 区块类型 | /wp/v2/block-types |
| 区块 | /wp/v2/blocks |
| 区块修订版 | /wp/v2/blocks/<id>/autosaves/ |
| 区块渲染器 | /wp/v2/block-renderer |
| 区块目录项 | /wp/v2/block-directory/search |
| 插件 | /wp/v2/plugins |
分布式 API
与许多其他 REST API 不同,WordPress REST API 是分布式的,并且在每个支持它的站点上单独可用。这意味着没有单一的 API 根或基础地址可供联系;相反,我们有一个 发现过程,允许在没有预先联系的情况下与站点交互。API 还在索引端点或通过向任何端点发送 OPTIONS 请求时暴露自我文档,从而允许人类或机器发现端点功能。