RESTful API
RESTful API是什么?
RESTful API就是程序之间进行数据交互时,必须遵守的规范
RESTful API本质上就是一个规范,定义规范的作用就是让我们写api的时候,更好做区分,更容易让后台去处理,并且让前端更容易记住这些url,说白了目标就是让这个url上可以体现出对这个api的一些操作。原来我们没用他之前,get,delete全都能实现只不过url得保存好多个,后来学了restful api之后,才渐渐的去使用它,但是在使用的时候发现也有一些不适用的,因为我们现在网站没有https就用http来实现的。
RESTful API的内容
1、协议
API与用户的通信协议,总是使用https协议。
2、域名
有两种方式
方式一: 尽量将API部署在专用域名(会存在跨域问题)
https://api.example.com
方式二:如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下。(推荐写法)
https://example.com/api/
3、版本
应该将API的版本号放入URL。
https://example.com/api/v1/
4、路径
应该将API的版本号放入URL。
url必须有名词:https://example.com/api/v1/user
5、HTTP动词
对于资源的具体操作类型,由HTTP动词表示。
常用的HTTP动词有下面五个(括号里是对应的SQL命令)。
GET :获取数据,从服务器取出资源(一项或多项)
POST :创建数据,在服务器新建一个资源。
PUT :更新,在服务器更新资源(客户端提供改变后的完整资源)。
PATCH :更新,在服务器更新资源(客户端提供改变的属性)。
DELETE:删除数据,从服务器删除资源。
6、过滤信息
如果记录数量很多,服务器不可能都将它们返回给用户。API应该提供参数,过滤返回结果。
下面是一些常见的参数。
?limit=10:指定返回记录的数量
?offset=10:指定返回记录的开始位置。
?page=2&per_page=100:指定第几页,以及每页的记录数。
?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序。
?animal_type_id=1:指定筛选条件
7、状态码
200 连接成功
301 重定向
302 临时重定向
403 服务器拒绝请求
404 服务器找不到请求网页
500 服务器错误
8、错误处理
如果状态码是4xx,就应该向用户返回出错信息。一般来说,返回的信息中将error作为键名,出错信息作为键值即可。
{
error: "Invalid API key"
}
9、返回结果
针对不同操作,服务器向用户返回的结果应该符合以下规范
GET /collection:返回资源对象的列表(数组)
GET /collection/resource:返回单个资源对象
POST /collection:返回新生成的资源对象
PUT /collection/resource:返回完整的资源对象
PATCH /collection/resource:返回完整的资源对象
DELETE /collection/resource:返回一个空文档