规范
# 数据的安全保障
一般采用https,不采用http,可以提高数据交互过程中的安全性
# 接口特征表现
https://api.xxx
可以让人一眼就看出来这是一个api
# 多数据版本共存
https://api.kl/v1
https://api.kl/v2
有时候接口是要改变的,因为接口在多个地方使用,不能立马修改,必须要多版本共存,保证之前的老app可以继续使用
# 数据即资源
https://api.xxx/books
books其实就代表了图书
在使用的时候全部都用名词来表示,不要用动词来表示
# 资源操作由读取方式来决定
操作一般是增删改查
https://api.xx/books -get post请求:获取所有书或者增加书
https://api.xx/books/1 get put patch delete 主键为1的书
# 过滤
在url上传参的形式增加传递条件
# 相应状态码
# 正常相应
200 常规请求
201穿件成功
# 重定向相应
301 永久重定向
302 暂时重定向
# 客户端异常
403 无请求权限
404 请求路径不存在
405 请求方法不存在
# 服务器异常
500 服务器异常
# 错误处理
返回错误信息,error当做key
{
error:'无权限操作'
}
1
2
3
2
3
# 返回结果
针对不同操作,服务器向用户返回的结果应该符合以下规范
GET/collection: 返回资源对象的列表(数组)
# 相应回来的数据可以带地址
'img':'https://w'
1
编辑 (opens new window)
上次更新: 2021/08/13, 23:21:49