开发者社区> 技术小能手> 正文
阿里云
为了无法计算的价值
打开APP
阿里云APP内打开

RESTful API 最佳实践

简介:
+关注继续查看

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

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

ccd71dedd03750c3582efa802d5c2e40c3115922

一、URL 设计

1.1 动词 + 宾语

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

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

 ●  GET:读取(Read)
 ●  POST:新建(Create)
 ●  PUT:更新(Update)
 ●  PATCH:更新(Update),通常是部分更新
 ●  DELETE:删除(Delete)


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

1.2 动词的覆盖

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

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


  1. POST /api/Person/4 HTTP/1.1  

  2. X-HTTP-Method-Override: PUT

上面代码中, X-HTTP-Method-Override指定本次请求的方法是 PUT,而不是 POST

1.3 宾语必须是名词

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

 ●  /getAllCars
 ●  /createNewCar
 ●  /deleteAllRedCars


1.4 复数 URL

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

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

为了统一起见,建议都使用复数 URL,比如 GET /articles/2要好于 GET/article/2

1.5 避免多级 URL

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


  1. GET /authors/12/categories/2

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

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


  1. GET /authors/12?categories=2

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


  1. GET /articles/published

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


  1. GET /articles?published=true

二、状态码

2.1 状态码必须精确

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

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

 ●  1xx:相关信息

 ●  2xx:操作成功

 ●  3xx:重定向

 ●  4xx:客户端错误

 ●  5xx:服务器错误

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

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

2.2 2xx 状态码

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

 ●  GET: 200 OK
 ●  POST: 201 Created
 ●  PUT: 200 OK
 ●  PATCH: 200 OK
 ●  DELETE: 204 No Content

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

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


  1. HTTP/1.1 202 Accepted

  2. {

  3.  "task": {

  4.    "href": "/api/company/job-management/jobs/2130040",

  5.    "id": "2130040"

  6.  }

  7. }

2.3 3xx 状态码

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

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


  1. HTTP/1.1 303 See Other

  2. Location: /api/orders/12345

2.4 4xx 状态码

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

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

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

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

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

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

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

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

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

429 Too Many Requests:客户端的请求次数超过限额。

2.5 5xx 状态码

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

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

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

三、服务器回应

3.1 不要返回纯本文

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

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


  1. GET /orders/2 HTTP/1.1

  2. Accept: application/json

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

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


  1. HTTP/1.1 200 OK

  2. Content-Type: application/json

  3. {

  4.  "status": "failure",

  5.  "data": {

  6.    "error": "Expected at least two items in list."

  7.  }

  8. }

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

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


  1. HTTP/1.1 400 Bad Request

  2. Content-Type: application/json

  3. {

  4.  "error": "Invalid payoad.",

  5.  "detail": {

  6.     "surname": "This field is required."

  7.  }

  8. }

3.3 提供链接

API 的使用者未必知道,URL 是怎么设计的。一个解决方法就是,在回应中,给出相关链接,便于下一步操作。这样的话,用户只要记住一个 URL,就可以发现其他的 URL。这种方法叫做 HATEOAS。

举例来说,GitHub 的 API 都在 api.github.com 这个域名。访问它,就可以得到其他 URL。


  1. {

  2.  ...

  3.  "feeds_url": "https://api.github.com/feeds",

  4.  "followers_url": "https://api.github.com/user/followers",

  5.  "following_url": "https://api.github.com/user/following{/target}",

  6.  "gists_url": "https://api.github.com/gists{/gist_id}",

  7.  "hub_url": "https://api.github.com/hub",

  8.  ...

  9. }

上面的回应中,挑一个 URL 访问,又可以得到别的 URL。对于用户来说,不需要记住 URL 设计,只要从 api.github.com 一步步查找就可以了。

HATEOAS 的格式没有统一规定,上面例子中,GitHub 将它们与其他属性放在一起。更好的做法应该是,将相关链接与其他属性分开。


  1. HTTP/1.1 200 OK

  2. Content-Type: application/json

  3. {

  4.  "status": "In progress",

  5.   "links": {[

  6.    { "rel":"cancel", "method": "delete", "href":"/api/status/12345" } ,

  7.    { "rel":"edit", "method": "put", "href":"/api/status/12345" }

  8.  ]}

  9. }

四、参考链接

 ●  RESTful API Design: 13 Best Practices to Make Your Users Happy(https://blog.florimondmanca.com/restful-api-design-13-best-practices-to-make-your-users-happy), by Florimond Manca

 ●  API design(https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design), by MicroSoft Azure


原文发布时间为:2018-10-15

本文作者:阮一峰

本文来自云栖社区合作伙伴“前端大学”,了解相关信息可以关注“前端大学”。

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
Yii2实现RESTful架构配置最佳实践
Yii2实现RESTful架构配置最佳实践
0 0
RESTful API 最佳实践
RESTful API 最佳实践
0 0
REST与RESTFul API最佳实践
RESTFul API已经是现在互联网里对外开放接口的主流模式
2995 0
RESTful API最佳实践(笔记)
RESTful API最佳实践
1117 0
RESTful JSON Web服务最佳实践
本文讲的是RESTful JSON Web服务最佳实践,Collaxa BPEL产品-后来成为Oracle SOA战略核心的一部分-背后的关键人物之一,Edwin Khodabakchian,已经单独致力于Feedly这一“将twitter和Google Reader编织成杂志一般的体验”的项目好几年了。
1171 0
【RESTful】Yii2实现RESTful架构配置最佳实践
Yii2实现RESTful架构配置最佳实践 为什么要用RESTful API 在服务器端,应用程序状态和功能可以分为各种资源。资源是一个有趣的概念实体,它向客户端公开。
994 0
开发 k8s 管理平台 - k8sailor 05. RESTFul API 接口规范与请求应答约定
开发 k8s 管理平台 - k8sailor 05. RESTFul API 接口规范与请求应答约定
0 0
软件测试|Spring Boot 的 RESTful API 设计与实现
软件测试|Spring Boot 的 RESTful API 设计与实现
0 0
+关注
技术小能手
云栖运营小编~
文章
问答
文章排行榜
最热
最新
相关电子书
更多
API 网关实践
立即下载
API 平台的安全实践
立即下载
API平台的安全实践
立即下载