RESTful API 设计指南

作者：阮一峰

网络应用程序，分为前端和后端两个部分。当前的发展趋势，就是前端设备层出不穷（手机、平板、桌面电脑、其他专用设备……）。

因此，必须有一种统一的机制，方便不同的前端设备与后端进行通信。这导致api构架的流行，甚至出现“api first”的设计思想。restful api是目前比较成熟的一套互联网应用程序的api设计理论。我以前写过一篇《理解restful架构》，探讨如何理解这个概念。

今天，我将介绍restful api的设计细节，探讨如何设计一套合理、好用的api。我的主要参考资料是这篇《principles of good restful api design》。

api与用户的通信协议，总是使用https协议。

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

</blockquote>

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

应该将api的版本号放入url。

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

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

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

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

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

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

常用的http动词有下面五个（括号里是对应的sql命令）。

get（select）：从服务器取出资源（一项或多项）。 post（create）：在服务器新建一个资源。 put（update）：在服务器更新资源（客户端提供改变后的完整资源）。 patch（update）：在服务器更新资源（客户端提供改变的属性）。 delete（delete）：从服务器删除资源。

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

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

下面是一些例子。

get /zoos：列出所有动物园 post /zoos：新建一个动物园 get /zoos/id：获取某个指定动物园的信息 put /zoos/id：更新某个指定动物园的信息（提供该动物园的全部信息） patch /zoos/id：更新某个指定动物园的信息（提供该动物园的部分信息） delete /zoos/id：删除某个动物园 get /zoos/id/animals：列出某个指定动物园的所有动物 delete /zoos/id/animals/id：删除某个指定动物园的指定动物

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

下面是一些常见的参数。

?limit=10：指定返回记录的数量 ?offset=10：指定返回记录的开始位置。 ?sortby=name&amp;order=asc：指定返回结果按照哪个属性排序，以及排序顺序。 ?animal_type_id=1：指定筛选条件

参数的设计允许存在冗余，即允许api路径和url参数偶尔有重复。比如，get /zoo/id/animals 与 get /animals?zoo_id=id 的含义是相同的。

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

200 ok – [get]：服务器成功返回用户请求的数据，该操作是幂等的（idempotent）。 201 created – [post/put/patch]：用户新建或修改数据成功。 204 no content – [delete]：用户删除数据成功。 400 invalid request – [post/put/patch]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。。 404 not found – [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。 500 internal server error – [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

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

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

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

get /collection：返回资源对象的列表（数组） get /collection/resource：返回单个资源对象 post /collection：返回新生成的资源对象 put /collection/resource：返回完整的资源对象 patch /collection/resource：返回完整的资源对象 delete /collection/resource：返回一个空文档

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

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

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

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

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

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

（1）api的身份认证应该使用oauth 2.0框架。

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

（完）

源自阮一峰个人博客