app开发要求规范—app接口开发要求规范文档v1.0.doc

{北京天晴APP接口规范文档}手机客户端接口文档文件状态:[]草稿[√]正式发布[]正在修改文件标识:当前版本::北京天晴完成日期:版本历史版本/、概述 1二、查询类接口格式规范 3三、操作类接口 6四、上传下载类 8五、推送类接口 8六、通用返回格式 10七、附录 11一、。实质就是以特定的规则通过接口直接操作数据库的增删改查。,服务端根据参数依据需求,前往数据库查询需要的结果返回数据的一类接口。返回类型一般有两种。第一种是返回一个对象,第二种是返回一个数组对象。第一种比如登陆,客户端把用户名密码上传到接口,服务器返回用户的个人信息。第二种比如获取客户,客户端把用户的身份信息上传到接口,服务器返回此身份下的所有客户数组集合。,客户端通过接口进行一些增删改的操作。比如新增一个客户,修改客户信息,或者删除一个客户。服务器一般返回执行的状态,有的需要返回执行结果的一些信息,比如新增客户后,返回客户的ID。。比如上传头像,需要上传图片到服务器,服务端根据需求响应保存并返回结果。比如客户端需要显示用户头像,需要读取网络图片文件,在手机上进行显示。,获取需要信息之外。有时候,也存在服务端有消息需要通知客户端的情况,这时候就是服务端向客户端发送消息。这类需求可以通过客户端短时间类循环请求解决,也可以通过第三方专业推送解决。也可以通过自己使用socket或者xmpp等协议进行开发。二、,fail结果失败ResponseObject响应体Key1int响应字段值Key2String响应字段值Key3Object响应字段值可以依然包含对象体Key3_Key1int响应字段值{"result":"ok","Response":{"userName":"Mary","sex":1,"Address":[{"city":"JiNan"},{"county":"LiXia"}]}}:,不传递默认第一页Size