Restful 架构
(1) 每一个URL代表一种资源
(2) 客户端与服务器之间,传递这种资源的某种表现层
(3) 客户端通过 4 个HTTP动词,对服务器端资源进行操作,实现“表现层状态转化”
REST 接口规范
1. 动作
GET (SELECT):从服务器检索资源
POST (CREATE): 从服务器创建新资源
PUT (UPDATE):从服务器更新资源,提供整个资源
PATCH (UPDATE): 从服务器更新资源,仅提供更改的属性
DELETE (DELETE):从服务器删除资源
2. 路径
表示API的具体网址
网址中不能有动词,只能有名词,而且与数据库表格名对应
3. 版本
应该将版本号放入URL
例如:https://api.example.com/v1/
4. 过滤信息
- 如果记录数量多,服务器不可能都返回
- API应该提供参数,过滤返回结果
例如:?limit = 10 指定返回数量
?page_number = 2&page_size = 100 指定页码与数量
5. 状态码
1xx 信息,请求收到,继续处理
2xx 成功,行为被成功接收
3xx 重定向
4xx 客户端错误(语法或请求无法实现)
5xx 服务端
200 ok
201 用户新建或修改数据成功
202 后台排队(异步任务)
204 数据库删除成功
400 用户请求错误
401 没有权限
403 有权限但是被禁止
404 页面没有找到
500 服务器错误
502 网关错误
503 service unavaiable
504 网关超时