资源用URI统一标识,URI只使用名词来指定资源,原则上不使用动词,因为它们是资源的标识。
最佳实践:
URL root:
API versioning:
可以放在URL里,也可以用HTTP的header:
/api/v1/
URI使用名词而非动词,推荐复数:
BAD
-
/getProducts
-
/listOrders
-
/retrieveClientByOrder?orderId=1
GOOD
- GET /products
return the 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架构或者说整个网络处理的核心。比如:
获取某人的新鲜事
获取某
《一线大厂Java面试题解析+后端开发学习笔记+最新架构讲解视频+实战项目源码讲义》
【docs.qq.com/doc/DSmxTbFJ1cmN1R2dB】 完整内容开源分享
人的好友列表
获取某人的详细信息
用HTTP协议里的动词来实现资源的添加,修改,删除等操作,即通过HTTP动词实现资源的状态扭转:
DELETE http://api.qc.com/v1/friends
删除某人的好友 (在http parameter指定好友id)
POST http://api.qc.com/v1/friends
添加好友
UPDATE http://api.qc.com/v1/profile
更新个人资料
禁止使用:
GET http://api.qc.com/v1/deleteFriend
Server和Client之间传递某资源的一个表现形式,比如用JSON,XML传输文本,或者用JPG,WebP传输图片等。当然还可以压缩HTTP传输时的数据(on-wire data compression)。
用 HTTP Status Code传递Server的状态信息。比如最常用的 200 表示成功,500 表示Server内部错误等。
Web端不再用之前典型的JSP架构,而是改为前段渲染和附带处理简单的商务逻辑(比如AngularJS或者BackBone的一些样例)。Web端和Server只使用上述定义的API来传递数据和改变数据状态。格式一般是JSON。iOS和Android同理可得。由此可见,Web,iOS,Android和第三方开发者变为平等的角色通过一套API来共同消费Server提供的服务。
=============================================================================