APP开发规范方案 APP接口开发规范方案文档V1.0.doc

{ 北京天晴APP接口规范文档}
手机客户端接口文档
文件状态:
[ ] 草稿
[√] 正式发布
[ ] 正在修改
文件标识:
当前版本:

作者:
北京天晴
完成日期:
版本历史
版本/状态
作者
参与者
起止日期
备注

韩磊
移动小组
目录
一、概述 1
有关接口 1
1
接口的分类 1
1
操作类接口 1
1
1
二、查询类接口格式规范 1
1
请求格式 1
2
2
2
请求格式 2
3
3
三、操作类接口 4
新增操作 4
4
4
4
4
修改操作 5
5
5
5
5
删除操作 5
5
6
6
6
四、上传下载类 6
上传文件 6
6
7
7
7
下载文件 7
7
7
8
8
五、推送类接口 8
推送消息 8
8
8
8
8
六、通用返回格式 9
正确返回 9
9
9
9
9
错误返回 9
9
10
10
10
七、附录 10
通用错误返回列表 10
URL地址信息 11
主机地址 11
URL列表 11
安全机制 11
验证签名机制 11
其他 11
列表数据为空的返回 11
一、概述
有关接口

APP接口是移动设备和业务之间进行通信的途径。实质就是以特定的规则通过接口直接操作数据库的增删改查。
接口的分类

查询类接口是指客户端传递一些参数,服务端根据参数依据需求,前往数据库查询需要的结果返回数据的一类接口。
返回类型一般有两种。第一种是返回一个对象,第二种是返回一个数组对象。
第一种比如登陆,客户端把用户名密码上传到接口,服务器返回用户的个人信息。
第二种比如获取客户,客户端把用户的身份信息上传到接口,服务器返回此身份下的所有客户数组集合。
操作类接口
操作类接口是指,客户端通过接口进行一些增删改的操作。比如新增一个客户,修改客户信息,或者删除一个客户。服务器一般返回执行的状态,有的需要返回执行结果的一些信息,比如新增客户后,返回客户的ID。

上传下载类接口是涉及到文件传输的接口。比如上传头像,需要上传图片到服务器,服务端根据需求响应保存并返回结果。比如客户端需要显示用户头像,需要读取网络图片文件,在手机上进行显示。

除了客户端主动去请求服务端,获取需要信息之外。有时候,也存在服务端有消息需要通知客户端的情况,这时候就是服务端向客户端发送消息。这类需求可以通过客户端短时间类循环请求解决,也可以通过第三方专业推送解决。也可以通过自己使用socket或者xmpp等协议进行开发。
二、查询类接口格式规范

请求格式
URL
支持格式
JOSN
HTTP请求方式
POST
是否登录验证
请求数限制

参数名
必选
类型及范围
说明
xxx
true
String
用户名

返回键
类型
返回值
说明
result
String
结果代码信号
ok 结果成功, fail结果失败
Response
Object
响应体