search

mishe / blog

前端碰上的问题或体会
230 stars 39 forks source link

前后端接口API接口规范 #126

Open mishe opened 8 years ago

mishe commented 8 years ago

Api地址: /api/vn/…. Vn：api版本，可以多版本的api共存，方便app端历史版本的兼容。 例如：/api/v1/product/1 /api/v2/product/1

传入参数:

  1. 地址栏
  2. 查询字串
  3. Cookie
  4. Header 返回数据 见返回数据模板；

接口返回模板： { status:0, data:{}, msg:’’ }

Status: 接口的执行的状态 0表示成功 <0 表示有异常

0 表示接口有部分执行失败

Data 接口的主数据，可以根据实际返回数组或HASH

Msg 当status!=0 都应该有错误信息

具体api接口可以使用阿里的rap服务 Rap在线体验