1 / 16
文档名称:

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

格式:doc   大小:219KB   页数:16页
下载后只包含 1 个 DOC 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

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

上传人:漫山花海 2019/3/4 文件大小:219 KB

下载得到文件列表

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

相关文档

文档介绍

文档介绍:{北京天晴APP接口规范文档}手机客户端接口文档文件状态:[]草稿[√]正式发布[]正在修改文件标识:当前版本::北京天晴完成日期:版本历史版本/、概述 1 1 1 1 1二、查询类接口格式规范 1 2 2 3 3三、操作类接口 4 4 4 4 5 5 5 5 5 5 6 6 6四、上传下载类 6 6 7 7 7 7 7 8 8五、推送类接口 8 8 8 8 8六、通用返回格式 9 9 9 9 9 9 10 10 10七、附录 11一、。实质就是以特定的规则通过接口直接操作数据库的增删改查。,服务端根据参数依据需求,前往数据库查询需要的结果返回数据的一类接口。返回类型一般有两种。第一种是返回一个对象,第二种是返回一个数组对象。第一种比如登陆,客户端把用户名密码上传到接口,服务器返回用户的个人信息。第二种比如获取客户,客户端把用户的身份信息上传到接口,服务器返回此身份下的所有客户数组集合。,客户端通过接口进行一些增删改的操作。比如新增一个客户,修改客户信息,或者删除一个客户。服务器一般返回执行的状态,有的需要返回执行结果的一些信息,比如新增客户后,返回客户的ID。上传下载类接口是涉及到文件传输的接口。比如上传头像,需要上传图片到服务器,服务端根据需求响应保存并返回结果。比如客户端需要显示用户头像,需要读取网络图片文件,在手机上进行显示。除了客户端主动去请求服务端,获取需要信息之外。有时候,也存在服务端有消息需要通知客户端的情况,这时候就是服务端向客户端发送消息。这类需求可以通过客户端短时间类循环请求解决,也可以通过第三方专业推送解决。也可以通过自己使用socket或者xmpp等协议进行开发。二、,fail结果失败ResponseObject响应体Key1int响应字段值Key2String响应字段值Key3Object响应字段值可以依然包含对象体Key3_Key1int响应字段值{"result":"ok","Response":{"userName":"Mary","sex":1,"Address":[{"city":"JiNan"},{"county":"LiXia"}]}}详见:,不传递默认第一页Sizefalseint一页多少条,不传递默认20条返回键类型返回值说明resultString结果代码信号ResponseObject响应体LastUpdateTimeString最后一条更新时间根据此时间判断新旧ThisPageNumberint当前页条数判断是否为空,是否有下页DataListArray[Object]对象列表时间倒序排列{“result”:”ok”,"Response":{"LastUpdateTime":"2012-12-1122:01:09","ThisPageNumber":2,"DataList":[{"id":1,"date":"2014-07-24","detail":"","points":50},{"id":2,"date":"2014-07-24","detail":"","points":50}]}}详见:通用错误返回列表三、