RESTful API

具象状态传输(Representational State Transfer,REST)是Roy Thomas Fielding于2000年的论文Architectural Styles and the Design of Network-based Software Architectures中阐述的一种软件架构风格风格,其具有结构清晰、符合标准、易于理解、扩展方便的优点,被广泛采用
此处参考阮一峰的文章,对RESTful API做简要介绍。

协议

通信使用HTTP协议

域名

应尽量将API部署到专用域名下,如:

1
https://api.example.com

版本(Version)

若有,应将版本放入URL。如:

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

路径

在RESTful架构中,每一个网址都代表一种资源,所有网址中应尽量避免出现动词,只能有名词。且根据实际情况,名词需要考虑是否为复数。
如对一个学校,有教师、学生、教室信息,则其API则应为:

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

HTTP Verbs

HTTP动词定义了资源的具体操作类型,最常用的动词为GET和POST,具体有:

GET(SELECT):从服务器取出资源(一项或多项)。
POST(CREATE):在服务器新建一个资源。
PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。
PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性)。
DELETE(DELETE):从服务器删除资源。
HEAD:获取资源的元数据。
OPTIONS:获取信息,关于资源的哪些属性是客户端可以改变的。

其中,需要区别POST、PUT、PATCH的使用区别,可参照此文

状态码

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 - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。

详细可参照w3官方文档

其他

  • API的身份及安全由OAuth 2.0控制
  • 交互的数据应尽量使用JSON。

Reference

WIKI:https://zh.wikipedia.org/wiki/REST
REST论文:http://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm
阮一峰博客:http://www.ruanyifeng.com/blog/2014/05/restful_api.html
HTTP Verbs:https://ihower.tw/blog/archives/6483