RESTful API 设计原则

Technical

协议

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

域名

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

1
https://api.example.com

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

1
https://example.org/api/

版本

应该将 API 的版本号带入 URL

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

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

路径（Endpoint）

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

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

举例来说，有一个API提供学校人员（school）的信息，包括老师和学生等信息，则它的路径应该设计成下面这样

1
2
3
https://api.example.com/v1/students

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

HTTP动词

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

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

  • GET（SELECT）：从服务器取出资源（一项或多项）
  • POST（CREATE）：在服务器新建一个资源
  • PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）
  • PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）
  • DELETE（DELETE）：从服务器删除资源

还有两个不常用的HTTP动词

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

下面是一些例子

  • GET /students：列出所有学生
  • POST /students：新建一个学生
  • GET /students/ID：获取某个指定学生的信息
  • PUT /students/ID：更新某个指定学生的信息（提供该学生的全部信息）
  • PATCH /students/ID：更新某个指定学生的信息（提供该学生的部分信息）
  • DELETE /students/ID：删除某个学生
  • GET /students/ID/scores：列出某个指定学生的所有成绩
  • DELETE /students/ID/scores/ID：删除某个指定学生的指定学科分数

过滤信息（Filtering）

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

下面是一些常见的参数

  • ?limit=10：指定返回记录的数量
  • ?offset=10：指定返回记录的开始位置
  • ?page=2&per_page=100：指定第几页，以及每页的记录数
  • ?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序
  • ?animal_type_id=1：指定筛选条件
  • 参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如，GET /students/ID/scores与 GET /scores?student_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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功

错误处理（Error handling）

如果状态码是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的根目录发出请求，会得到这样一个文档

1
2
3
4
5
6
7
8
{
    "link": {
      "rel":   "collection https://www.example.com/students",
      "href":  "https://api.example.com/students",
      "title": "List of students",
      "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 的网址列表

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
  "current_user_url": "https://api.github.com/user",
  "current_user_authorizations_html_url": "https://github.com/settings/connections/applications{/client_id}",
  "authorizations_url": "https://api.github.com/authorizations",
  "code_search_url": "https://api.github.com/search/code?q={query}{&page,per_page,sort,order}",
  "emails_url": "https://api.github.com/user/emails",
  "emojis_url": "https://api.github.com/emojis",
  "events_url": "https://api.github.com/events",
  "feeds_url": "https://api.github.com/feeds",
  "followers_url": "https://api.github.com/user/followers",
  "following_url": "https://api.github.com/user/following{/target}",
  "gists_url": "https://api.github.com/gists{/gist_id}",
  "hub_url": "https://api.github.com/hub",
  "issue_search_url": "https://api.github.com/search/issues?q={query}{&page,per_page,sort,order}",
  "issues_url": "https://api.github.com/issues",
  "keys_url": "https://api.github.com/user/keys",
  "notifications_url": "https://api.github.com/notifications",
  "organization_repositories_url": "https://api.github.com/orgs/{org}/repos{?type,page,per_page,sort}",
  "organization_url": "https://api.github.com/orgs/{org}",
  "public_gists_url": "https://api.github.com/gists/public",
  "rate_limit_url": "https://api.github.com/rate_limit",
  "repository_url": "https://api.github.com/repos/{owner}/{repo}",
  "repository_search_url": "https://api.github.com/search/repositories?q={query}{&page,per_page,sort,order}",
  "current_user_repositories_url": "https://api.github.com/user/repos{?type,page,per_page,sort}",
  "starred_url": "https://api.github.com/user/starred{/owner}{/repo}",
  "starred_gists_url": "https://api.github.com/gists/starred",
  "team_url": "https://api.github.com/teams",
  "user_url": "https://api.github.com/users/{user}",
  "user_organizations_url": "https://api.github.com/user/orgs",
  "user_repositories_url": "https://api.github.com/users/{user}/repos{?type,page,per_page,sort}",
  "user_search_url": "https://api.github.com/search/users?q={query}{&page,per_page,sort,order}"
}

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

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

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

其他

  1. API 的身份认证应该使用 OAuth 2.0 框架
  2. 服务器返回的数据格式，应该尽量使用 JSON，避免使用 XML