api规范

1、https传输数据
2、接口关键字
3、多版本共存


4、使用名词
5、资源操作由请求方式决定
get：获取所有书
post：新增一本
put：修改
patch：局部修改
delete：删除
6、过滤，通过url参数传递条件
limit=10 返回记录条件
offset=10 指定返回记录的开始位置
page=2&per_page=10 指定第几页，每页的记录数
sortby=name&order=asc:指定返回结果按照哪个属性排序
animal_type_id=1 指定筛选条件
7、状态码
200 常规请求成功
201 创建成功
301 永久重定向
302 暂时重定向
403 请求无权限
404 请求不存在
405 请求方法不存在
500 服务器异常
8、错误处理，返回错误信息
{
error:‘错误信息‘
}
9、返回结果
GET /collection:返回资源对象的列表
GET /collection/resource:返回单个资源对象
POST /collection:返回新生成的资源对象
PUT /collection/resource:返回完整的资源对象
PATCH /collection/resource:返回完整的资源对象
DELETE /collection/resource:返回一个空文档
10、返回资源的链接地址

原文：https://www.cnblogs.com/zybyekai/p/14010661.html