一、什么是RESTful规范
它是一个规范,面向资源架构
10条规范:
1. API与用户的通信协议,总是使用HTTPs协议
2. 域名
https://api.example.com 尽量将API部署在专用域名(会存在跨域问题)
https://example.org/api/
3. 版本
https://api.example.com/v1/ 把版本号放在请求头中
4. 路径,视网络上任何东西都是资源,均使用名词表示(可复数)
127.0.0.1/books/
5. method,通过请求方式来表示进行的操作
127.0.0.1/books/ get请求:表示获取所有图书
127.0.0.1/books/1 get请求:表示获取id为1的图书
127.0.0.1/books/ post请求:表示新增一本书
127.0.0.1/books/ delete请求:表示删除一本书
127.0.0.1/books/ put/patch请求:表示修改一本书
6. 过滤,通过在url上传参的形式传递搜索条件
https://api.example.com/v1/zoos?limit=10 指定返回记录的数量
7. 状态码
1开头:服务器正在处理
2开头:服务器处理成功
3开头:重定向
4开头:客户端错误
5开头:服务器错误
8. 错误处理,应返回错误信息,error当做key
{
error: "Invalid API key"
}
9. 返回结果针对不同操作,返回数据格式要求
10. 返回结果中提供链接