REST全称是Representational State Transfer
RESTful是一种定义Web API接口的设计风格,尤其适用于前后端分离的应用模式中。
这种风格的理念认为后端开发任务就是提供数据的,对外提供的是数据资源的访问接口,所以在定义接口时,客户端访问的URL路径就表示这种要操作的数据资源。
事实上,我们可以使用任何一个框架都可以实现符合restful规范的API接口.
RESTful作为目前最流行的 API 设计规范,一定有着它独有的魅力:强大、简介、易上手.
(1)数据的安全保障:
url链接一般都采用https协议进行传输 注:采用https协议,可以提高数据交互过程中的安全性
(2)接口特征表现,一看就知道是个api接口
- 用api关键字标识接口url:
- [http://api.baidu.com](http://api.baidu.com/)
- http://www.baidu.com/api
注:看到api字眼,就代表该请求url链接是完成前后台数据交互的
-路飞的接口:http://api.luffycity.com/api/v1/course/free/
(3)多数据版本共存
- 在url链接中标识数据版本
- http://api.baidu.com/v1
- http://api.baidu.com/v2
注:url链接中的v1、v2就是不同数据版本的体现(只有在一种数据资源有多版本情况下:例如在原有版本上增加接口,类似改版,也需要保证老版本可以使用)
(4)数据即资源(均使用名词)
接口一般都是完成前后台数据的交互,交互的数据我们称之为资源
http://api.baidu.com/users
http://api.baidu.com/books
http://api.baidu.com/book
注:一般提倡用资源的复数形式,在url链接中奖励不要出现操作资源的动词,错误示范:http://api.baidu.com/delete-user
特殊的接口可以出现动词,因为这些接口一般没有一个明确的资源,或是动词就是接口的核心含义
http://api.baidu.com/place/search
http://api.baidu.com/login
(5)资源操作由请求方式决定(method)
- 操作资源一般都会涉及到增删改查,我们提供请求方式来标识增删改查动作
- http://api.baidu.com/books - get请求:获取所有书
- http://api.baidu.com/books/1 - get请求:获取主键为1的书
- http://api.baidu.com/books - post请求:新增一本书书
- http://api.baidu.com/books/1 - put请求:整体修改主键为1的书
- http://api.baidu.com/books/1 - patch请求:局部修改主键为1的书
- http://api.baidu.com/books/1 - delete请求:删除主键为1的书
(6)过滤,通过在url上传参的形式传递搜索条件
- http://api.example.com/v1/zoos?limit=10:指定返回记录的数量
- http://api.example.com/v1/zoos?offset=10:指定返回记录的开始位置
- http://api.example.com/v1/zoos?page=2&per_page=100:指定第几页,以及每页的记录数
- http://api.example.com/v1/zoos?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序
- http://api.example.com/v1/zoos?animal_type_id=1:指定筛选条件
(7)响应状态码
1)正常响应
- 响应状态码2xx
- 200:常规请求
- 201:创建成功
2)重定向响应
- 响应状态码3xx
- 301:永久重定向
- 302:暂时重定向
3)客户端异常
- 响应状态码4xx
- 403:请求无权限
- 404:请求路径不存在
- 405:请求方法不存在
4)服务器异常
- 响应状态码5xx
- 500:服务器异常
(8)错误处理,应返回错误信息,error当做key
{
error: "无权限操作"
}
(9)返回结果,针对不同操作,服务器向用户返回的结果应该符合以下规范
GET /collection:返回资源对象的列表(数组)
GET /collection/resource:返回单个资源对象
POST /collection:返回新生成的资源对象
PUT /collection/resource:返回完整的资源对象
PATCH /collection/resource:返回完整的资源对象
DELETE /collection/resource:返回一个空文档
(10)需要url请求的资源:需要访问资源的请求链接
# Hypermedia API,RESTful API最好做到Hypermedia,即返回结果中提供链接,连向其他API方法,使得用户不查文档,也知道下一步应该做什么
{
"status": 0,
"msg": "ok",
"results":[
{
"name":"肯德基(罗餐厅)",
"img": "http://image.baidu.com/kfc/001.png"
}
...
]
}
你适合学Java吗?4大专业测评方法
代码逻辑 吸收能力 技术学习能力 综合素质
先测评确定适合在学习