RESTful API 设计规范

API

随着 WEB 技术的发展，各种设备（手机、平板、PC、其他专用设备）及近几年各种前端框架（ React、Angular、Vuejs）等的层出不穷，使得 WEB 开发占据着举足轻重的地位，同时也给前后端数据交互带来新的挑战。在开发过程中，前后端的数据交互也变得越来越密切，我们迫切需要一个统一的 API 接口规范设计，方便不同的前端设备与后端进行通信。这导致 API 构架的流行，甚至出现 “API First” 的设计思想。RESTful API 是目前比较成熟的一套互联网应用程序的 API 设计理论。今天，我将介绍 RESTful API 的设计细节，探讨如何设计一套合理、好用的 API。主要参考了Github 的 API 设计规范，我按照自己的理解总结了一下。

协议

为了确保信息安全，API 与用户的通信协议，总是使用HTTPS协议。

域名

为了进一步提高 API 的扩展性，应该尽量将 API 部署在专用域名之下，如：https://api.example.com

版本

建议将 API 的版本号放入URL中，如：https://api.example.com/v1/。但是 Github 采取了另外一种方案，就是将版本号放入了 HTTP 头信息中，看这里看这里，但个人感觉不太直观。

路径

在 RESTful 架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的集合名对应。所以 API 中的名词也应该统一使用复数形式。

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

1
2
3

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

请求方法

对于资源的具体操作类型，由 HTTP 动词表示，常用的 HTTP 请求方法有五个，分别如下：

请求方法	描述
GET	从服务器取出资源（一项或多项）
POST	在服务器新建一个资源
PUT	在服务器完整的更新资源（客户端提供改变后的完整资源）
PATCH	在服务器更新资源（客户端提供改变的属性）
DELETE	从服务器删除资源

还有两个不常用的 HTTP 请求方法，分别如下：

请求方法	描述
HEAD	获取资源的元数据
OPTIONS	获取信息，关于资源的哪些属性是客户端可以改变的

下面是一些例子，说明各请求方式的用法：

GET /users 列出所有用户
GET /users/:ID 列出指定用户信息
POST /users 新增一个用户
DELETE /users/:ID 删除指定用户
PUT /users/:ID 更新指定用户信息（提供该用户的全部信息）
PATCH /users/:ID 更新指定用户信息（提供该用户的部分信息）

请求参数

如果记录数量很多，服务器不可能都将它们返回给用户。API 应该提供参数，过滤返回结果，下面是一些常见的参数：

?limit=10 指定返回记录的数量
?offset=10 指定返回记录的开始位置
?page=2&per_page=100 指定第几页，以及每页的记录数
?sortby=name&order=asc 指定返回结果按照哪个属性排序，以及排序顺序
?animal_type_id=1 指定筛选条件

状态码

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

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 API key"
}

返回结果

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

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

十、Hypermedia API

RESTful API 最好做到 Hypermedia，即返回结果中提供链接，连向其他 API 方法，使得用户不查文档，也知道下一步应该做什么。

比如，当用户向 api.example.com 的根目录发出请求，会得到这样一个文档：

{
  "link": {
    "rel":   "collection https://www.example.com/zoos",
    "href":  "https://api.example.com/zoos",
    "title": "List of zoos",
    "type":  "application/vnd.yourformat+json"
  }
}

上面代码表示，文档中有一个 link 属性，用户读取这个属性就知道下一步该调用什么 API 了。rel 表示这个 API 与当前网址的关系（collection关系，并给出该collection的网址），href 表示 API 的路径，title 表示 API 的标题，type 表示返回类型。

Hypermedia API 的设计被称为 HATEOAS。Github的API就是这种设计，访问 api.github.com 会得到一个所有可用 API 的网址列表：

{
  "current_user_url": "https://api.github.com/user",
  "authorizations_url": "https://api.github.com/authorizations",
  // ...
}

从上面可以看到，如果想获取当前用户的信息，应该去访问api.github.com/user，然后就得到了下面结果：

{
  "message": "Requires authentication",
  "documentation_url": "https://developer.github.com/v3"
}

上面代码表示，服务器给出了提示信息，以及文档的网址。

其他

（1）API 的身份认证应该使用 OAuth 2.0 框架

（2）服务器返回的数据格式，应该尽量使用 JSON，避免使用XML

楠枫渡

Thinking && coding