REST这个词,是Roy Thomas Fielding在他2000年的博士论文中提出的。
他参与设计了HTTP协议,也是Apache Web Server项目(可惜现在已经是 Nginx 的天下)的co-founder。
论文地址:Architectural Styles and the Design of Network-based Software Architectures
REST章节:Fielding Dissertation: CHAPTER 5: Representational State Transfer (REST)
Fielding将他对互联网软件的架构原则,定名为REST ,即Representational State Transfer的缩写,资源在网络中以某种表现形式进行状态转移。
如果一个架构符合REST原则,就称它为RESTful架构。
Resource Re
presentational S
tate T
ransfer,通过URI+动作来操作一个资源。
Resource
资源,即数据(网络的核心)。将网络上的信息实体看作是资源,比如可以是:
-
文本
-
图片
-
服务
-
音频
…
标识
资源用URI统一标识,URI只使用名词来指定资源,原则上不使用动词,因为它们是资源的标识。
最佳实践:
URL root:
API versioning:
可以放在URL里,也可以用HTTP的header:
/api/v1/
URI使用名词而非动词,推荐复数:
BAD
-
/getProducts
-
/listOrders
-
/retrieveClientByOrder?orderId=1
GOOD
- GET /products
return t
《一线大厂Java面试题解析+后端开发学习笔记+最新架构讲解视频+实战项目源码讲义》
【docs.qq.com/doc/DSmxTbFJ1cmN1R2dB】 完整内容开源分享
he list of all products
- POST /products
add a product to the collection
- GET /products/4
retrieve product
- PATCH/PUT /products/4
update product
Representational 表现层
Representational:某种表现形式,比如用JSON,XML,JPEG。
- 文本
txt、html、 xml、json、二进制
- 图片
jpg、png
- http协议的 content-type 和 accept
Case:
book是一个资源,获取不同的格式
State Transfer
State Transfer:状态转化。通过HTTP动词实现,用以操作这些资源。
- 幂等性
每次HTTP请求相同的参数,相同的URI,产生的结果是相同的
- GET-获取资源
http://www.book.com/book/001
- POST-创建资源,不具有幂等性
http://www.book.com/book/
- PUT-创建(更新)资源
http://www.book.com/book/001
- DELETE-删除资源
http://www.book.com/book/001
REST描述的是在网络中client和server的一种交互形式。REST本身不实用,实用的是如何设计 RESTful API(REST风格的网络接口)。
Server提供的RESTful API中,URL中只使用名词来指定资源,原则上不使用动词。
“资源”是REST架构或者说整个网络处理的核心。比如:
获取某人的新鲜事
获取某人的好友列表
获取某人的详细信息