什么是REST
REST不是”rest”这个单词,而是几个单词的缩写 REpresentation State Transfer,直接翻译:表现层状态转移,这个翻译不太好理解。网上找到一个比较通俗的说法是:URL定位资源,用HTTP动词(GET,POST,DELETE,PUSH等)描述操作
REST描述的是在网络中client和server的一种交互形式
Restful api接口有什么特征?
1.URL的根路径
http://api.chesxs.com/v1
2.需要有api版本信息
http://api.chesxs.com/v1
3.URL中只使用名词指定资源,不用动词,且推荐使用复数
服务(Server)提供的RESTful API中,URL中只使用名词来指定资源,原则上不使用动词。“资源”是REST架构或者说整个网络处理的核心。比如:
http://api.chesxs.com/v1/cars // 获取某个账户下的车辆列表
http://api.chesxs.com/v1/fences // 获取某个账户下的围栏列表
4. 用HTTP协议里的动词来实现资源的添加,修改,删除等操作。即通过HTTP动词来实现资源的状态扭转
GET 用来获取资源,
POST 用来新建资源(也可以用于更新资源)。比如:POST http://api.chesxs.com/v1/car: 添加车辆
PUT 用来更新资源,
DELETE 用来删除资源。比如:DELETE http://api.chesxs.com/v1/cars 删除某辆车 (在http parameter指定好友id)
UPDATE http://api.chesxs.com/v1/fence 更新围栏信息
错误使用: GET http://api.chesxs.com/v1/deleteCar 删除车辆
5.GET应该是安全的,不会改变资源状态
这个应该很好理解,get的时候就只是获取资源,而不涉及添加、更新、删除资源。
6.使用正确的HTTP Status Code返回状态码
常用的有404,200,500,400等等。
7.过滤信息
如果记录数量很多,服务器不可能都将它们返回给用户。API应该提供参数,过滤返回结果。
下面是一些常见的参数。
?limit=10:指定返回记录的数量
?offset=10:指定返回记录的开始位置。
?page=2&per_page=100:指定第几页,以及每页的记录数。
?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序。
?producy_type=1:指定筛选条件
8.规范返回的数据
为了保障前后端的数据交互的顺畅,建议规范数据的返回,并采用固定的数据格式封装。
接口返回模板:
{
status:0,
data:{}||[],
msg:’’
}
总结
看一个标准的restful api要可以做到:
- 看Url就知道要操作的资源是什么,是操作车辆还是围栏
- 看Http Method就知道操作动作是什么,是添加(post)还是删除(delete)
- 看Http Status Code就知道操作结果如何,是成功(200)还是内部错误(500)
为什么使用Restful
-
前后端分离
-
后端接口复用
近年随着移动互联网的发展,各种类型的客户端层出不穷,Restful可以通过一套统一的接口为PC、微信(H5)、IOS和Android提供服务,这样的接口不需要前端样式,只提供数据