REST API术语表

本文为您在使用REST API时可能遇到的一些常用术语提供了一个术语表。

API

API代表应用程序编程接口,它并没有真正解释太多。可以这样考虑:API接收入站请求并发送出站响应。您发出请求,API将该请求传递给服务器,然后等待服务器的响应。应用程序的用户界面(UI)允许用户与其交互,而应用程序编程接口(API)允许客户端与应用程序交互。它只是与系统及其功能交互的另一种方式。

休息

REST代表具象状态转移。REST API是一种遵循六个特定架构约束的API,这些约束使与它们的交互更容易,资源消耗更少。

有关详情,请参阅表征状态转移在维基百科上。

JSON

Zend亚博esk API是一个JSON API,这意味着它只接受并返回JSON数据。

JSON代表JavaScript对象表示法,但不要让JavaScript部分迷惑了您。JSON不是一种编程语言:它是一种人类可读的数据格式。JSON格式可用于以标准方式存储和传输信息。

JSON遵循严格的语法。注意逗号、冒号、圆括号和大括号({})。他们会是你最好的朋友和最大的敌人。

为了突出JSON的可读性,这里有一个语法(和事实)正确的JSON对象,你甚至可以在不了解JSON的情况下解释它:

             
{“事实”{“名称”“格雷格”“is_cool”真正的}}

要了解更多信息,请参见使用JSON

CRUD

创建,读取,更新,删除。把它们看作动词。它们告诉API创建、读取、更新或删除记录。在Internet上,这四个动词对应HTTP请求方法:GET(读取)、PUT(更新)、POST(创建)、DELETE(删除)。不止这四个请求方法但这些是最常见的。

GET(读)请求是最基本的HTTP方法。你在浏览网页的时候会一直使用它。例如,当你使用谷歌搜索时,你的网络浏览器会发出一个接一个的GET请求。

端点

您使用端点来实际调用API。顾名思义,端点是接收web请求的位置。API是端点的集合。每个端点都有自己的CRUD操作规则。

HTTP响应状态码

当你向端点发出请求时,服务器:

  1. 查看发送的信息。
  2. 查找请求中引用的资源。
  3. 检查您是否有访问权限。
  4. 返回带有状态码的响应。

每个状态码都有一个特定的含义。它们被方便地分为以下五组:

  • (100-199)信息反应
  • (200-299)成功响应
  • (300-399)重定向消息
  • (400-499)客户端错误(你搞砸了)
  • (500-599)服务器错误(服务器混乱)

有关详情,请参阅HTTP状态码列表在维基百科上。这不是一个确定的列表,一些基础设施公司,如Cloudflare,有他们自己的状态代码集。如果您看到在任何地方都找不到的奇怪的新状态码,请记住这一点。

有效载荷

当一艘船携带有效载荷到一个港口时,一些HTTP请求携带有效载荷到一个API。创建记录或更新现有记录的HTTP请求也需要将数据传送到API。例如,当使用API在Zendesk中创建用户时,您需要将用户信息发送给AP亚博I。有效负载包含API将用于在Zendesk中创建用户的新用户信息(JSON格式)。亚博