1.使用HTTPs协议,确保交互数据的传输安全
2.应该尽量将API部署在专用域名之下,如:https://api.example.com
3.应该将API的版本号放入URL中,如:https://api.example.com/v{n}/
4.网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。
一般来说,数据库中的表都是同种记录的"集合"(collection),所以API中的名词也应该使用复数,如:https://api.example.com/v1/products
5.对于资源的具体操作类型,由HTTP动词表示,常用的HTTP动词有四个。
GET(SELECT):从服务器取出资源(一项或多项)。
POST(CREATE):在服务器新建一个资源。
PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。
DELETE(DELETE):从服务器删除资源。
如:GET/products:列出所有商品
6.如果记录数量很多,服务器不可能都将它们返回给用户。API应该提供参数,过滤返回结果。
下面是一些常见的参数。
?limit=10:指定返回记录的数量
?offset=10:指定返回记录的开始位置。
?page=2&per_page=100:指定第几页,以及每页的记录数。
?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序。
?producy_type=1:指定筛选条件
7.传入参数分为4种类型:
1)地址栏参数
* restful 地址栏参数 /api/v1/product/122 122为产品编号,获取产品为122的信息
* get方式的查询字串 见过滤信息小节
2)请求body数据
3)cookie
4)request header
cookie和header 一般都是用于OAuth认证的2种途径
8.返回数据
接口返回模板:
{
status:0,
data:{}||[],
msg:’’
}
备注:欢迎加入web前端求职招聘qq群:668352707