API 接口定义案例

前端所有业务接口，返回的 json 数据格式都是：

{
’error' : 10000 ****或者**** ‘’****，**** // 10000 -> ****代表校验不通过；**** ‘’ -> ****代表已经通过校验
'msg' : ‘’ // error = 10000 时，msg 会有错误提示；error = ‘’, msg = ‘’ , 或 msg 值为二维数组的 json 数据格式
};

注册

http://example.com/prefix_route/auth/register

要求数据格式：
array(
‘name’ => ‘不能为空’， // 长度 >= 5 字符
‘pwd’ => ‘不能为空’， // 长度 >= 5 字符
‘repwd’ => ‘不能为空’,
‘mobile’ => ‘非必须’
)

返回的 jason 格式：
array(
’error' => 10000 ****或者**** ‘’****，**** // 10000 -> ****代表校验不通过；**** ‘’ -> ****代表已经通过校验
'msg' => ‘’ // error = 10000 时，msg 会有错误提示；error = ‘’, msg = ‘’；
);

登陆
http://example.com/prefix_route/auth/login

要求数据格式：
array(
‘name’ => ‘不能为空’，
‘pwd’ => ‘不能为空’
)

返回的 jason 格式：
array(
’error' => 10000 ****或者**** ‘’****，**** // 10000 -> ****代表校验不通过；**** ‘’ -> ****代表已经通过校验
'msg' => ‘’ // error = 10000 时，msg 会有错误提示；error = ‘’, msg = ‘’；
);

退出
http://example.com/prefix_route/auth/logout

要求数据格式：
array(
‘name’ => ‘不能为空’，
‘pwd’ => ‘不能为空’
)

返回的 jason 格式：
array(
’error' => 10000 ****或者**** ‘’****，**** // 10000 -> ****代表校验不通过；**** ‘’ -> ****代表已经通过校验
'msg' => ‘’ // error = 10000 时，msg 会有错误提示；error = ‘’, msg = ‘’；
);

添加设备

http://example.com/prefix_route/device/create

要求数据格式：
array(
‘device_id’ => ‘不能为空’，
‘device_name’ => ‘不能为空’
)

返回的 jason 格式：
array(
’error' => 10000 ****或者**** ‘’****，**** // 10000 -> ****代表校验不通过；**** ‘’ -> ****代表已经通过校验
'msg' => ‘’ // error = 10000 时，msg 会有错误提示；error = ‘’, msg = ‘’；
);

获取所有的设备

http://example.com/prefix_route/device/devices

要求：必须先登陆才可以获取到数据

返回的 jason 格式：
’error' => 10000 ****或者**** ‘’****，**** // 10000 -> ****代表校验不通过；**** ‘’ -> ****代表已经通过校验
{"error":"","msg":[{"device_id":"12345678","device_name":"123456789","agent_name“:null,"agent_phone":"123456789","description":"123456465","latitude":null,"longitude":null,"address":null,"price":null,"created_date":"2016-08-12 16:33:26","updated_date":"2016-08-12 16:33:26”}, …]}

接口修改：

用户退出，只需要传送 token 值。
登陆成功之后，我会在返回值那里，msg = 'token' 。 后面的每一次通讯，你都给我发送你的 token 值