APP开发标准规范设计-APP接口开发标准规范设计文档V1.0.doc
《APP开发标准规范设计-APP接口开发标准规范设计文档V1.0.doc》由会员分享,可在线阅读,更多相关《APP开发标准规范设计-APP接口开发标准规范设计文档V1.0.doc(16页珍藏版)》请在得力文库 - 分享文档赚钱的网站上搜索。
1、 北京天晴 APP 接口规范文档 手机客户端接口文档 文件标识:当前版本:1.0作 者:北京天晴 文件状态: 草稿 正式发布 正在修改完成日期:版 本 历 史版本/状态作者参与者起止日期备注V1.0/草稿韩磊移动小组目录目录一、概述.1 1.1 有关接口.1 1.1.1 接口是纯数据的交互.1 1.2 接口的分类.1 1.2.1 查询类接口.1 1.2.2 操作类接口.1 1.2.3 上传下载类接口.1 1.2.4 推送类接口.1 二、查询类接口格式规范.1 2.1 获取单条对象信息.1 2.1.1 请求格式.1 2.1.2 参数说明.2 2.1.3 正常返回结果.2 2.2 获取列表对象信息
2、.2 2.2.1 请求格式.2 2.2.2 参数说明.3 2.2.3 正常返回结果.3 三、操作类接口.4 3.1 新增操作.4 3.1.1 接口说明.4 3.1.2 参数说明.4 3.1.3 正常返回结果.4 3.1.4 错误返回列表.4 3.2 修改操作.5 3.2.1 接口说明.5 3.2.2 参数说明.5 3.2.3 正常返回结果.5 3.2.4 错误返回列表.5 3.3 删除操作.5 3.3.1 接口说明.5 3.3.2 参数说明.6 3.3.3 正常返回结果.6 3.3.4 错误返回列表.6 四、上传下载类.6 4.1 上传文件.6 4.1.1 接口说明.6 4.1.2 参数说明.
3、7 4.1.3 正常返回结果.7 4.1.4 错误返回列表.7 4.2 下载文件.7 4.2.1 接口说明.74.2.2 参数说明.7 4.2.3 正常返回结果.8 4.2.4 错误返回列表.8 五、推送类接口.8 5.1 推送消息.8 5.1.1 接口说明.8 5.1.2 参数说明.8 5.1.3 正常返回结果.8 5.1.4 错误返回列表.8 六、通用返回格式.9 6.1 正确返回.9 6.1.1 接口说明.9 6.1.2 参数说明.9 6.1.3 正常返回结果.9 6.1.4 错误返回列表.9 6.2 错误返回.9 6.2.1 接口说明.9 6.2.2 参数说明.10 6.2.3 正常返
4、回结果.10 6.2.4 错误返回列表.10 七、附录.10 7.1 通用错误返回列表.10 7.2 URL 地址信息.11 7.2.1 主机地址.11 7.2.2 URL 列表.11 7.3 安全机制.11 7.3.1 验证签名机制.11 7.4 其他.11 7.2.1 列表数据为空的返回.11一、一、概述概述1.1 有关接口有关接口1.1.1 接口接口是纯数据的交互是纯数据的交互APP 接口是移动设备和业务之间进行通信的途径。实质就是以特定的规则通过接口直 接操作数据库的增删改查。1.2 接口的分类接口的分类1.2.1 查询类接口查询类接口查询类接口是指客户端传递一些参数,服务端根据参数依
5、据需求,前往数据库查询需 要的结果返回数据的一类接口。 返回类型一般有两种。第一种是返回一个对象,第二种是返回一个数组对象。 第一种比如登陆,客户端把用户名密码上传到接口,服务器返回用户的个人信息。 第二种比如获取客户,客户端把用户的身份信息上传到接口,服务器返回此身份下的 所有客户数组集合。1.2.2 操作类接口操作类接口操作类接口是指,客户端通过接口进行一些增删改的操作。比如新增一个客户,修改 客户信息,或者删除一个客户。服务器一般返回执行的状态,有的需要返回执行结果的一 些信息,比如新增客户后,返回客户的 ID。1.2.3 上传下载类接口上传下载类接口上传下载类接口是涉及到文件传输的接口
6、。比如上传头像,需要上传图片到服务器, 服务端根据需求响应保存并返回结果。比如客户端需要显示用户头像,需要读取网络图片 文件,在手机上进行显示。1.2.4 推送类接口推送类接口除了客户端主动去请求服务端,获取需要信息之外。有时候,也存在服务端有消息需 要通知客户端的情况,这时候就是服务端向客户端发送消息。这类需求可以通过客户端短 时间类循环请求解决,也可以通过第三方专业推送解决。也可以通过自己使用 socket 或者 xmpp 等协议进行开发。二、二、查询类接口格式规范查询类接口格式规范2.1 获取获取单条对象信息单条对象信息2.1.1 请求格式请求格式URL支持格式JOSNHTTP 请求方
7、式POST是否登录验证请求数限制2.1.2 参数说明参数说明参数名必选类型及范围说明xxxtrueString用户名2.1.3 正常返回结果正常返回结果返回键类型返回值说明resultString结果代码信号ok 结果成功, fail 结果失 败ResponseObject响应体Key1int 响应字段值Key2 String 响应字段值Key3 Object 响应字段值可以依然包含对象体Key3_Key1 int 响应字段值“result“:“ok“ ,“Response“: “userName“: “Mary“,“sex“: 1,“Address“: “city“: “JiNan“,“co
8、unty“: “LiXia“ 2.1.4 错误返回列表错误返回列表 详见:通用错误返回列表2.2 获取获取列表对象信息列表对象信息2.2.1 请求格式请求格式URL支持格式JOSNHTTP 请求方 式POST是否登录验证请求数限制2.2.2 参数说明参数说明参数名必选类型及范围说明xxxtrueString用户名Pagefalseint第几页,不传递默认第一页Sizefalseint一页多少条,不传递默认 20 条2.2.3 正常返回结果正常返回结果返回键类型返回值说明resultString结果代码信号ResponseObject响应体LastUpdateTimeString 最后一条更新时
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- APP 开发 标准规范 设计 接口 文档 V1
限制150内