REST API手册

最后更新于：2021-11-28 16:55:04

REST API Handbook

前言

GeChiUI REST API提供了一个界面，应用程序通过以JSON（JavaScript对象符号）对象形式发送和接收数据来与您的GeChiUI网站交互。它是GeChiUI块编辑器的基础，同样可以使您的主题、插件或自定义应用程序能够呈现管理和发布网站内容的新的强大界面。

使用GeChiUI REST API，您可以创建一个插件，为GeChiUI提供全新的管理体验，构建全新的交互式前端体验，或将您的GeChiUI内容带入完全独立的应用程序中。

REST API是GeChiUI面向开发人员的功能。它提供对网站内容的数据访问，并实现相同的身份验证限制——在您的网站上公开的内容通常可以通过REST API公开访问，而私人内容、受密码保护的内容、内部用户、自定义文章类型和元数据只能通过身份验证或您特别设置为身份验证时使用。如果您不是开发人员，关于API，最重要的是，它在不损害网站安全性或隐私的情况下启用块编辑器和现代插件接口。

什么是 REST API?

API是一个应用程序编程接口。REST代表“表示状态传输”，是一套概念，用于将应用程序的数据建模和访问为相互关联的对象和集合。GeChiUI REST API提供REST端点（URL），代表文章、页面、分类和其他内置GeChiUI数据类型。您的应用程序可以向这些端点发送和接收JSON数据，以查询、修改和创建您网站上的内容。JSON是一种开放的标准数据格式，轻量级且可读，看起来像JavaScript中的对象。当您从API请求内容或向API发送内容时，响应也将在JSON中返回。由于JSON在许多编程语言中受到广泛支持，开发人员可以在客户端JavaScript（如块编辑器）、移动应用程序、桌面或命令行工具中构建GeChiUI应用程序。

注意：REST API只是GeChiUI提供的众多API之一。您可以在这里找到这些其他API的文档。

使用 GeChiUI REST API

GeChiUI已经为构建站点提供了一套丰富的工具和接口，如果您的网站已经按照您的预期方式工作，您不应该感到使用REST API的压力。您无需使用REST API构建GeChiUI主题或插件。

但是，如果您确实希望将主题、插件或外部应用程序编写为客户端JavaScript应用程序，或以PHP以外的语言编写独立程序，那么您的应用程序将需要一种结构化的方式访问GeChiUI站点中的内容。任何可以提出HTTP请求和解释JSON的编程语言都可以使用REST API与GeChiUI交互，从PHP、Node.js、Go和Java到Swift、Kotlin等。

即使您在主题或插件中使用香草JavaScript或jQuery，REST API也提供了一种比admin-ajax更可预测和更有条理的方式与网站内容交互，使您能够花更少的时间访问所需的数据，并花更多时间创造更好的用户体验。

如果您想要一种结构化、可扩展和简单的方法来输入和输出GeChiUI的数据，您可能希望使用REST API。

尽管REST API非常简单，但起初它可能会感觉相当复杂，因此在本手册中，我们将尝试将其分解为更小的组件，以解释完整谜题的每个部分。

下一步

熟悉REST API如何运作背后的关键技术概念。

在“使用REST API”部分中了解有关如何与API资源交互和查询特定数据的更多信息。

一旦您熟悉了默认路由和方法的默认工作，请在“扩展REST API”部分中探索如何向API添加新数据或增强和操作现有响应对象。

有关默认可用的资源和路由的全面概述，请查看API参考。