词汇表

最后更新于：2021-11-28 23:11:33

Glossary

REST API的新手？了解我们文档中使用的短语。

控制器

是软件开发的标准结构。如果您还不熟悉它，您应该做一些阅读以跟上进度。

在GC-API中，我们采用了控制器概念，为表示我们资源端点的类制定标准结构。所有资源端点都扩展了GC_REST_Controller，以确保它们实现通用方法。

HEAD, GET, POST, PUT, 和 DELETE Requests

These “HTTP verbs” represent the type of action a HTTP client might perform against a resource. For instance, GET requests are used to fetch a Post’s data, whereas DELETE requests are used to delete a Post. They’re collectively called “HTTP verbs” because they’re standardized across the web.

If you’re familiar with GeChiUI functions, a GET request is the equivalent of gc_remote_get(), and a POST request is the same as gc_remote_post().

这些“HTTP术语”表示HTTP客户端可能对资源执行的操作类型。例如，GET请求用于获取文章的数据，而DELETE请求用于删除文章。它们统称为“HTTP请求”，因为它们在网络上是标准化的。

如果您熟悉GeChiUI函数，GET请求相当于 gc_remote_get()，a POST 请求与 gc_remote_post()相同。

HTTP客户端 HTTP Client

“HTTP 客户端”一词是指您用于与GC-API交互的工具。您可以使用Postman（Chrome）或REST Easy（Firefox）在浏览器中测试请求，或使用httpie在命令行测试请求。

GeChiUI itself provides a HTTP Client in the GC_HTTP class and related functions (e.g. gc_remote_get()). This can be used to access one GeChiUI site from another.

资源 Resource

“资源”是GeChiUI中的独立实体。您可能已经将这些资源称为文章、页面、评论、用户、条款等。GC-API允许HTTP客户端根据资源执行CRUD操作（CRUD代表创建、读取、更新和删除）。

从实用性上讲，以下是您通常与GC-API资源的交互方式：

  • GET /gc-json/gc/v2/posts 获取一系列文章。这大致相当于使用 GC_Query.
  • GET /gc-json/gc/v2/posts/123 获得ID为123的单个文章。这大致相当于使用 get_post().
  • POST /gc-json/gc/v2/posts 创建新文章。这大致相当于使用 gc_insert_post().
  • DELETE /gc-json/gc/v2/posts/123 删除ID为123的文章。这大致相当于 gc_delete_post().

路由 Routes / 端点 Endpoints

端点是通过API可用的函数。这可能是检索API索引、更新文章或删除评论。端点执行特定功能，获取一些参数并将数据返回给客户端。

路由是您用于访问URL中使用的端点的“名称”。路由可以有多个端点与之关联，使用的端点取决于HTTP请求。

例如，使用URL http://example.com/gc-json/gc/v2/posts/123:

  • “路由”是gc/v2/posts/123——路由不包括gc-json，因为gc-json是API本身的基础路径。
  • 此路由有3个端点：
    • GET 触发 get_item 方法，将文章数据返回给客户端。
    • PUT triggers an update_item method, taking the data to update, and returning the updated post data.
    • DELETE 触发 delete_item 方法，将现在删除的文章数据返回给客户端。

注意：在没有相当永久链接的网站上，路由将作为rest_route参数添加到URL中。对于上述示例，完整的URL将是 http://example.com/?rest_route=gc/v2/posts/123

结构 结构

“结构”是GC-API响应数据的格式表示。例如，Post结构传达，获取Post的请求将返回id、title、content、author和其他字段。我们的结构还指示每个字段的类型，提供可读的描述，并显示字段将在哪些上下文中返回。