RESTful API 最佳实践

RESTful 是目前最流行的 API 设计规范,用于 Web 数据接口的设计。

它的大原则容易把握,但是细节不容易做对。本文总结 RESTful 的设计细节,介绍如何设计出易于理解和使用的 API。

一、URL 设计

1.1 动词 + 宾语

RESTful 的核心思想就是,客户端发出的数据操作指令都是"动词 + 宾语"的结构。比如, 这个命令,是动词,是宾语。

动词通常就是五种 HTTP 方法,对应 CRUD 操作。

GET:读取(Read)

POST:新建(Create)

PUT:更新(Update)

PATCH:更新(Update),通常是部分更新

DELETE:删除(Delete)

根据 HTTP 规范,动词一律大写。

1.2 动词的覆盖

有些客户端只能使用和这两种方法。服务器必须接受模拟其他三个方法(、、)。

这时,客户端发出的 HTTP 请求,要加上属性,告诉服务器应该使用哪一个动词,覆盖方法。

上面代码中,指定本次请求的方法是,而不是。

1.3 宾语必须是名词

宾语就是 API 的 URL,是 HTTP 动词作用的对象。它应该是名词,不能是动词。比如,这个 URL 就是正确的,而下面的 URL 不是名词,所以都是错误的。

/getAllCars

/createNewCar

/deleteAllRedCars

1.4 复数 URL

既然 URL 是名词,那么应该使用复数,还是单数?

这没有统一的规定,但是常见的操作是读取一个集合,比如(读取所有文章),这里明显应该是复数。

为了统一起见,建议都使用复数 URL,比如要好于。

1.5 避免多级 URL

常见的情况是,资源需要多级分类,因此很容易写出多级的 URL,比如获取某个作者的某一类文章。

这种 URL 不利于扩展,语义也不明确,往往要想一会,才能明白含义。

更好的做法是,除了第一级,其他级别都用查询字符串表达。

下面是另一个例子,查询已发布的文章。你可能会设计成下面的 URL。

查询字符串的写法明显更好。

二、状态码

2.1 状态码必须精确

客户端的每一次请求,服务器都必须给出回应。回应包括 HTTP 状态码和数据两部分。

HTTP 状态码就是一个三位数,分成五个类别。

:相关信息

:操作成功

:重定向

:客户端错误

:服务器错误

这五大类总共包含100多种状态码,覆盖了绝大部分可能遇到的情况。每一种状态码都有标准的(或者约定的)解释,客户端只需查看状态码,就可以判断出发生了什么情况,所以服务器应该返回尽可能精确的状态码。

API 不需要 状态码,下面介绍其他四类状态码的精确含义。

2.2 2xx 状态码

状态码表示操作成功,但是不同的方法可以返回更精确的状态码。

GET: 200 OK

POST: 201 Created

PUT: 200 OK

PATCH: 200 OK

DELETE: 204 No Content

上面代码中,返回状态码,表示生成了新的资源;返回状态码,表示资源已经不存在。

此外,状态码表示服务器已经收到请求,但还未进行处理,会在未来再处理,通常用于异步操作。下面是一个例子。

2.3 3xx 状态码

API 用不到状态码(永久重定向)和状态码(暂时重定向,也是这个含义),因为它们可以由应用级别返回,浏览器会直接跳转,API 级别可以不考虑这两种情况。

API 用到的状态码,主要是,表示参考另一个 URL。它与和的含义一样,也是"暂时重定向",区别在于和用于请求,而用于、和请求。收到以后,浏览器不会自动跳转,而会让用户自己决定下一步怎么办。下面是一个例子。

2.4 4xx 状态码

状态码表示客户端错误,主要有下面几种。

:服务器不理解客户端的请求,未做任何处理。

:用户未提供身份验证凭据,或者没有通过身份验证。

:用户通过了身份验证,但是不具有访问资源所需的权限。

:所请求的资源不存在,或不可用。

:用户已经通过身份验证,但是所用的 HTTP 方法不在他的权限之内。

:所请求的资源已从这个地址转移,不再可用。

:客户端要求的返回格式不支持。比如,API 只能返回 JSON 格式,但是客户端要求返回 XML 格式。

:客户端上传的附件无法处理,导致请求失败。

:客户端的请求次数超过限额。

2.5 5xx 状态码

状态码表示服务端错误。一般来说,API 不会向用户透露服务器的详细信息,所以只要两个状态码就够了。

:客户端请求有效,服务器处理时发生了意外。

:服务器无法处理请求,一般用于网站维护状态。

三、服务器回应

3.1 不要返回纯本文

API 返回的数据格式,不应该是纯文本,而应该是一个 JSON 对象,因为这样才能返回标准的结构化数据。所以,服务器回应的 HTTP 头的属性要设为。

客户端请求时,也要明确告诉服务器,可以接受 JSON 格式,即请求的 HTTP 头的属性也要设成。下面是一个例子。

3.2 发生错误时,不要返回 200 状态码

有一种不恰当的做法是,即使发生错误,也返回 状态码,把错误信息放在数据体里面,就像下面这样。

上面代码中,解析数据体以后,才能得知操作失败。

这张做法实际上取消了状态码,这是完全不可取的。正确的做法是,状态码反映发生的错误,具体的错误信息放在数据体里面返回。下面是一个例子。

3.3 提供链接

  • 发表于:
  • 原文链接https://kuaibao.qq.com/s/20181013A0IVSJ00?refer=cp_1026
  • 腾讯「云+社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。
  • 如有侵权,请联系 yunjia_community@tencent.com 删除。

扫码关注云+社区

领取腾讯云代金券