RESTful Api 规范

发表于 | 分类于 | 评论数： | 阅读次数：

协议

API与用户的通信协议,总是使用HTTPS协议,确保交互数据的传输安全。

域名

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

1
https://api.example.com

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

1
https://example.org/api/

版本

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

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

路径

路径又称”终点”（endpoint），表示API的具体网址。

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

举例来说，有一个API提供图书馆（library）的信息，还包括各种书籍和工作人员的信息，则它的路径应该设计成下面这样

1
2
3
·  https://api.example.com/v1/library
·  https://api.example.com/v1/books
·  https://api.example.com/v1/staffs

HTTP请求方式

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

常用的HTTP动词有下面四个（括号里是对应的SQL命令）。

1
2
3
4
5
6
7
8
9
GET（SELECT）：从服务器取出资源（一项或多项）。

POST（CREATE）：在服务器新建一个资源。

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

PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。

DELETE（DELETE）：从服务器删除资源。

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

1
2
3
HEAD：获取资源的元数据。

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

下面是一些例子。

1
2
3
4
5
6
7
8
9
10
11
12
13
GET /product：列出所有商品

POST /product：新建一个商品

GET /product/ID：获取某个指定商品的信息

PUT /product/ID：更新某个指定商品的信息

DELETE /product/ID：删除某个商品

GET /product/ID/purchase ：列出某个指定商品的所有投资者

get /product/ID/purchase/ID：获取某个指定商品的指定投资者信息

过滤信息

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

下面是一些常见的参数。

1
2
3
4
5
6
7
8
9
?limit=10：指定返回记录的数量

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

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

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

?producy_type=1：指定筛选条件

状态码

服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。

1
2
3
4
5
6
7
8
9
10
11
12
·  200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
·  201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
·  202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
·  204 NO CONTENT - [DELETE]：用户删除数据成功。
·  400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
·  401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
·  403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
·  404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
·  406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
·  410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
·  422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
·  500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

状态码的完全列表参见这里

错误处理

如果状态码是4xx，就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。

1
2
3
{
    error: "Invalid Request"
}

返回结果

针对不同操作，服务器向用户返回的结果应该符合以下规范。

1
2
3
4
5
6
·   GET /collection：返回资源对象的列表（数组）
·   GET /collection/resource：返回单个资源对象
·   POST /collection：返回新生成的资源对象
·   PUT /collection/resource：返回完整的资源对象
·   PATCH /collection/resource：返回完整的资源对象
·   DELETE /collection/resource：返回一个空文档

注意事项

  • 服务器返回的数据格式，应该尽量使用JSON，避免使用XML。
  • 行业公认比较好的RESTFUL设计思想为HATEOAS
0%