协议

API 与用户的通信协议，总是使用 HTTPs 协议。

域名

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

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

https://example.org/api/

版本

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

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

路径（Endpoint）

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

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

路径设计规范：

  • URL 使用小写字母
  • 多个单词使用下划线 ‘_’ 分割
  • 资源要使用名词的复数形式，如 users、rooms

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

HTTP 方法

对于资源的具体操作类型，由 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：删除某个指定动物园的指定动物；

过滤信息（Filtering）

如果记录数量很多，服务器不可能都将它们返回给用户。API 应该提供参数，过滤返回结果。推荐参数使用小写字母，多个单词使用下划线 ‘_’ 分割。

下面是一些常见的参数。

  • ?limit=10：指定返回记录的数量；
  • ?offset=10：指定返回记录的开始位置；
  • ?page_num=2&page_size=100：指定第几页，以及每页的记录数；
  • ?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序；
  • ?animal_type_id=1：指定筛选条件；
  • ?fields=id,name：指定返回数据字段；

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

状态码（Status Codes）

服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的 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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功；

文档参考：

RESTful API 设计指南
RESTful 接口规范
RESTful API 设计参考文献列表
Principles of good RESTful API Design

作者：殷建卫 链接：https://www.yuque.com/yinjianwei/vyrvkf/vq93id 来源：殷建卫 - 架构笔记 著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。