什么是RESTful API？Restful API接口设计标准 天天快资讯

什么是RESTful API：

1、RESTful API是REST风格的API，是一套用来规范多种形式的前端和同一个后台的交互方式的协议。RESTful API由后台也就是SERVER来提供前端来调用;前端调用API向后台发起HTTP请求，后台响应请求将处理结果反馈给前端。

2、RESTful API可以用于GET、PUT、POST和DELETE数据类型，这些数据类型与资源相关的操作读取、更新、创建和删除。RESTful API基于表示性状态转移(REST)，它是Web服务开发中经常使用的一种体系结构样式和通信方式。

Restful API接口设计标准：

1. 协议

API与用户的通信协议，尽量使用HTTPs协议。

2. 域名

应该尽量将API部署在专用域名之下。

https://api.example.com

如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。

https://example.org/api/

3. 版本

应该将API的版本号放入URL。

https://api.example.com/v1/

另一种做法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观。

Github采用这种做法。

4. 路径

路径又称“终点"(endpoint)，表示API的具体网址。

在RESTful架构中，每个网址代表一种资源(resource)，所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的“集合"(collection)，所以API中的名词也应该使用复数。

举例来说，有一个APl提供动物园(zoo)的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。

https://api.example.com/v1/zoos

https://api.example.com/v1/animals

https://api.example.com/v1/employees

5. HTTP 动词

对于资源的具体操作类型，由HTTP动词表示。

常用的HTTP动词有下面五个(括号里是对应的SQL命令)。

GET(读取)：从服务器取出资源(一项或多项)。

POST(创建)：在服务器新建一个资源。

PUT(完整更新)：在服务器更新资源(客户端提供改变后的完整资源)。

PATCH(部分更新)：在服务器更新资源(客户端提供改变的属性)。

DELETE(删除)：从服务器删除资源。

还有两个不常用的HTTP动词。

HEAD：获取资源的元数据。

OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。

下面是一些例子。

GET/zoos：列出所有动物园

POST/zoos：新建一个动物园

GET/z00S/ID：获取某个指定动物园的信息

PUT/zoos/ID：更新某个指定动物园的信息(提供该动物园的全部信息)

PATCH/zooS/ID：更新某个指定动物园的信息(提供该动物园的部分信息)

DELETE/zoos/ID：删除某个动物园

GET/zooS/ID/animals：列出某个指定动物园的所有动物

DELETE/zoos/ID/animals/ID：删除某个指定动物园的指定动物

6. 过滤信息

如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。

下面是一些常见的参数。

?limit=10：指定返回记录的数量

?offset=10：指定返回记录的开始位置。

?page=2&per_page=100：指定第几页，以及每页的记录数。

?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。

?animal_type_id=1：指定筛选条件

参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。

比如，GET/zo0/ID/animals 与 GET/animals?zoo_id=ID的含义是相同的。

7. 状态码

客户端的每一次请求，服务器都必须给出回应。回应包括HTTP状态码和数据两部分。

HTTP状态码就是一个三位数，分成五个类别。

1xx：相关信息

2xx：操作成功。

3xX：重定向

4xx：客户端错误

5xx：服务器错误