RESTful API设计理念

一、协议

API 与用户的通信协议, 总是使用 HTTPs 协议.

二、域名

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

https://api.example.com

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

https://example.org/api/

三、版本

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

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

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

四、路径

路径又称"终点"(endpoint), 表示 API 的具体网址.

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

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

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

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

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

五、HTTP 动词

GET(select): 从服务器取出资源(一项或多项).

POST(create):在服务器新建一个资源.

PUT(update):在服务器更新资源(客户端提供该变后的完整资源).

PATCH(update):在服务器更新资源(客户端提供改变的属性).

DELETE(delete): 从服务器删除资源.

六、过滤信息

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

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

?offset=10: 指定返回记录的开始位置.

?page=2&per_page=100: 指定第几页, 以及每页的纪律数.

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

?animal_type_id=1: 指定筛选条件.

七、状态码

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 作为键名, 出错信息作为键值即可.

{ 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": "collectionhttps://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 表示返回类型.

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。