API端点参考

最后更新于:2021-11-29 14:34:26

Reference

GeChiUI REST API围绕REST组织,旨在拥有可预测的、面向资源的URL,并使用HTTP响应代码来指示API错误。API使用内置的HTTP功能,如HTTP身份验证和HTTP请求,这些功能可以被现成的HTTP客户端理解,并支持跨源资源共享,允许您从客户端Web应用程序安全地与API交互。

REST API仅使用JSON作为请求和响应格式,包括错误响应。虽然REST API不完全符合HAL标准,但它确实实现了HAL的._links._embedded属性来链接API资源,并且可以通过响应中的超链接完全发现。

REST API提供任何客户端匿名访问的公共数据,以及只有在身份验证后才能使用的私有数据。一旦经过身份验证,REST API支持大多数内容管理操作,允许您为网站构建替代仪表板,使用更灵敏的管理工具增强插件,或构建复杂的单页应用程序。

此API引用提供有关通过API可用的特定端点、其参数和响应数据格式的信息。

REST API开发人员端点参考

资源路径
Posts/gc/v2/posts
Post Revisions/gc/v2/posts/<id>/revisions
Categories/gc/v2/categories
Tags/gc/v2/tags
Pages/gc/v2/pages
Page Revisions/gc/v2/pages/<id>/revisions
Comments/gc/v2/comments
Taxonomies/gc/v2/taxonomies
Media/gc/v2/media
Users/gc/v2/users
Post Types/gc/v2/types
Post Statuses/gc/v2/statuses
Settings/gc/v2/settings
Themes/gc/v2/themes
Search/gc/v2/search
Block Types/gc/v2/block-types
Blocks/gc/v2/blocks
Block Revisions/gc/v2/blocks/<id>/autosaves/
Block Renderer/gc/v2/block-renderer
Block Directory Items/gc/v2/block-directory/search
Plugins/gc/v2/plugins

分布式API

与许多其他REST API不同,GeChiUI REST API在支持它的每个网站上单独分发和可用。这意味着没有单一的API根或基点可以联系;相反,我们有一个发现过程,允许在不事先联系的情况下与网站交互。API还公开索引端点的自我文档,或通过OPTIONS请求向任何端点,允许人工或机器发现端点功能。

用于测试目的的API演示安装可在https://demo.gc-api.org/gc-json/上找到;本网站支持自动发现,并提供
只读演示数据。