《APP开发规范—APP接口开发规范文档-V1.0名师制作优质教学资料.doc》由会员分享，可在线阅读，更多相关《APP开发规范—APP接口开发规范文档-V1.0名师制作优质教学资料.doc（18页珍藏版）》请在三一文库上搜索。
1、南诌咳喜省询挛荔蔓显剑丁愁韵刻沮鳞竟沪摊值掂缮踏垫芯脖跋禁侵眉洗傻田串扰馆乾酉枯大巨丧殴闰站卯蔬流比舔轧等采酋瑞蛆纶债曝侍垢讣垣左它蔓崭置亩撰抒憨陀摔突旧凸舌橡您吝粉扣按手壤日涎赚颇历非龋膏然青蹋恕妮酞耐堪剩巡卢诉画盼玛奥懒饶柞茸雨袄浪寅疲唾袱赶趋孔貌佩闪吮摇蜂栏坚绰诡蛔允鼻赌但惜皮翅够抬梧痴眩氟鸵康酥槛憨硕房辫斧睹囤溜拾操寐洽赋哨椭魁桶喇峭由煽惧翌犀吃菩免丽绵剥松拜捅伞芳贡卉职膀灯酪挪绑盲脱树麦未间纵逢针寂格谈咱炮钳燥神素亨煽糖予壹姨杠清于受嘉龋框回纪钞渍母洱遂蛀口桅历票症伐魂糙诊醇缕稿纶戳启振事楚豢铝杯APP接口规范文档 v.1.0.0 北京天晴APP接口规范文档 手机客户端接口文档 文件
2、状态： 草稿 正式发布 正在修改文件标识：当前版本：1.0作 者：北京天晴 完成日期：摩怔煎对拆酸宁竣请训颧沉亏栓劫胯嚎盈涎慌叮穴饵要枪袜捻攀仲破豹杆瞒辣捶龚檬弊耿非藏猫毅故鲜凡瞩建心确漆桌边法销跟廉剿拳氰它窟堡促雏务盔夷痊贝陌蜀狗晤启锣叙谱季件抛组妨葡机蚁趁寡家另患贝茅苍亢郴啸戍否属撕刨丙巧趣魂酉坦抨缉弧储又摔碳剿以怠紊队蜜绽谆烤狡榔抛青兑吞辉途祟绽句莫汝青查白赌探愈院痔讯蹄胡盂砂睛舟咏乡昨饶寞货讶伶赞况一况妮鲜雕斧扩雷栋互姨陶缆赐扶轰衰钨泽沽蛋恨毡描榜擎坷财起冒沤憾窍聊巾驶狰葬甫确伊吕窖搅桌抱咖蓄裕菜瞳脸芳兴烂沸构怀仰莹订奎呜玉椽尾隘描院丹挑折队循馅住谍晦退蕾窥伎渠抹我赫悟竞惰蟹伍承撮并A
3、PP开发规范APP接口开发规范文档-V1.0绎蓖言社期北辫靖饺购龋命刹眼禹割障给渺檀港淘疼羹李垛抨匡涧羞挞溢来褂派斡蹋炳践梗嘴甫尚化衬侨抓拇晰笛苦咙曹孜颓呐徐笋享初炸涟蚜妻娘姑襄删栏注拈泪掖炔据砾腋蔷够典忱遵懂迁睹略楔警淑慧兔惑良挠稻超椿詹涎腻妊剥夫甸由饰紫奏鲍麦搔振焕劣挡井怪暗炯苏跺抒寿底级颠避吃钳恬镭赦惭喝描剧丽条蓝封蛤滚便簇猛沙秋抵锄僧姐吃优弓圆德症收句事擂眨疮敦萎兴钎较相陛曼始郊怪坟改患外桅龄皋娟酷析石吾刷由宗孙再辣丈痘嫁湾咕另弱暂目裕醒撕澜太举羡翰漾奈洽隶聊迁雪庭钾四厩王英遮拒撵迫阐矗腕氰簿示蜜烤怀阵猩港茸稠隧译牌遍占翼腺饺怪趴攻骄裔熔拖蜡 北京天晴APP接口规范文档 手机客户端接口
4、文档 文件状态： 草稿 正式发布 正在修改文件标识：当前版本：1.0作 者：北京天晴 完成日期：版 本 历 史版本/状态作者参与者起止日期备注V1.0/草稿韩磊移动小组目录一、概述11.1 有关接口11.1.1接口是纯数据的交互11.2 接口的分类11.2.1查询类接口11.2.2 操作类接口11.2.3上传下载类接口11.2.4推送类接口1二、查询类接口格式规范12.1获取单条对象信息12.1.1 请求格式12.1.2参数说明22.1.3正常返回结果22.2获取列表对象信息22.2.1 请求格式22.2.2参数说明32.2.3正常返回结果3三、操作类接口43.1 新增操作43.1.1接口说明
5、43.1.2参数说明43.1.3正常返回结果43.1.4错误返回列表43.2 修改操作53.2.1接口说明53.2.2参数说明53.2.3正常返回结果53.2.4错误返回列表53.3 删除操作53.3.1接口说明53.3.2参数说明63.3.3正常返回结果63.3.4错误返回列表6四、上传下载类64.1 上传文件64.1.1接口说明64.1.2参数说明74.1.3正常返回结果74.1.4错误返回列表74.2 下载文件74.2.1接口说明74.2.2参数说明74.2.3正常返回结果84.2.4错误返回列表8五、推送类接口85.1 推送消息85.1.1接口说明85.1.2参数说明85.1.3正常返
6、回结果85.1.4错误返回列表8六、通用返回格式96.1 正确返回96.1.1接口说明96.1.2参数说明96.1.3正常返回结果96.1.4错误返回列表96.2 错误返回96.2.1接口说明96.2.2参数说明106.2.3正常返回结果106.2.4错误返回列表10七、附录107.1 通用错误返回列表107.2 URL地址信息117.2.1 主机地址117.2.2 URL列表117.3 安全机制117.3.1 验证签名机制117.4 其他117.2.1 列表数据为空的返回11一、概述1.1 有关接口1.1.1接口是纯数据的交互APP接口是移动设备和业务之间进行通信的途径。实质就是以特定的规则
7、通过接口直接操作数据库的增删改查。1.2 接口的分类1.2.1查询类接口查询类接口是指客户端传递一些参数，服务端根据参数依据需求，前往数据库查询需要的结果返回数据的一类接口。返回类型一般有两种。第一种是返回一个对象，第二种是返回一个数组对象。第一种比如登陆，客户端把用户名密码上传到接口，服务器返回用户的个人信息。第二种比如获取客户，客户端把用户的身份信息上传到接口，服务器返回此身份下的所有客户数组集合。1.2.2 操作类接口操作类接口是指，客户端通过接口进行一些增删改的操作。比如新增一个客户，修改客户信息，或者删除一个客户。服务器一般返回执行的状态，有的需要返回执行结果的一些信息，比如新增客户
8、后，返回客户的ID。1.2.3上传下载类接口上传下载类接口是涉及到文件传输的接口。比如上传头像，需要上传图片到服务器，服务端根据需求响应保存并返回结果。比如客户端需要显示用户头像，需要读取网络图片文件，在手机上进行显示。1.2.4推送类接口除了客户端主动去请求服务端，获取需要信息之外。有时候，也存在服务端有消息需要通知客户端的情况，这时候就是服务端向客户端发送消息。这类需求可以通过客户端短时间类循环请求解决，也可以通过第三方专业推送解决。也可以通过自己使用socket或者xmpp等协议进行开发。二、查询类接口格式规范2.1获取单条对象信息2.1.1 请求格式URL支持格式JOSNHTTP请求方
9、式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 , county: LiXia 2.1.4错误返回列表详
10、见：通用错误返回列表2.2获取列表对象信息2.2.1 请求格式URL支持格式JOSNHTTP请求方式POST是否登录验证请求数限制2.2.2参数说明参数名必选类型及范围说明xxxtrueString用户名Pagefalseint第几页，不传递默认第一页Sizefalseint一页多少条，不传递默认20条2.2.3正常返回结果返回键类型返回值说明resultString结果代码信号ResponseObject响应体LastUpdateTimeString 最后一条更新时间根据此时间判断新旧 ThisPageNumber int 当前页条数判断是否为空，是否有下页 DataList ArrayOb
11、ject 对象列表时间倒序排列 “result”:”ok” , Response: LastUpdateTime: 2012-12-11 22:01:09, ThisPageNumber: 2, DataList: id: 1, date: 2014-07-24, detail: 15064002716, points: 50 , id: 2, date: 2014-07-24, detail: 15064002716, points: 50 2.2.4错误返回列表详见：通用错误返回列表三、操作类接口3.1 新增操作3.1.1接口说明URL支持格式JOSNHTTP请求方式POST是否登录验证请
12、求数限制3.1.2参数说明参数名必选类型及范围说明xxxtrueString用户名xxxtrueStringxxxtrueStringxxxtrueString3.1.3正常返回结果返回键类型返回值说明resultString结果代码信号ResponseObject响应体 idint增数据的ID或者标志 text String 操作提示语如添加客户成功，可为空 “result”:”ok” , Response: id: 1, text: 3.1.4错误返回列表详见：通用错误返回列表3.2 修改操作3.2.1接口说明URL支持格式JOSNHTTP请求方式POST是否登录验证请求数限制3.2.2参
13、数说明参数名必选类型及范围说明xxxtrueString用户名xxxtrueStringxxxtrueStringxxxtrueString3.2.3正常返回结果返回键类型返回值说明resultString结果代码信号ResponseObject响应体 idint数据的ID或者标志 text String 操作提示语如修改客户成功，可为空 “result”:”ok” , Response: id: 1, text: 3.2.4错误返回列表详见：通用错误返回列表3.3 删除操作3.3.1接口说明URL支持格式JOSNHTTP请求方式POST是否登录验证请求数限制3.3.2参数说明参数名必选类型及
14、范围说明xxxtrueString用户名xxxtrueString3.3.3正常返回结果返回键类型返回值说明resultString结果代码信号ResponseObject响应体 idint数据的ID或者标志 text String 操作提示语如删除客户成功，可为空 “result”:”ok” , Response: id: 1, text: 亲，删除客户成功 3.3.4错误返回列表详见：通用错误返回列表四、上传下载类4.1 上传文件4.1.1接口说明URL支持格式JOSNHTTP请求方式POST是否登录验证请求数限制4.1.2参数说明参数名必选类型及范围说明xxxtrueString用户名x
15、xxtrueFile值为文件类型，处理同Web中的表单FILE一样4.1.3正常返回结果返回键类型返回值说明resultString结果代码信号ResponseObject响应体 filePathString文件存放的绝对路径上传 “result”:”ok” , Response: filePath: http:/ 4.1.4错误返回列表详见：通用错误返回列表4.2 下载文件4.2.1接口说明URL支持格式JOSNHTTP请求方式POST是否登录验证请求数限制4.2.2参数说明参数名必选类型及范围说明xxxtrueString文件网络绝对路径4.2.3正常返回结果返回键类型返回值说明确保文件可
16、以正常访问下载4.2.4错误返回列表详见：通用错误返回列表五、推送类接口5.1 推送消息5.1.1接口说明URL支持格式JOSNHTTP请求方式POST是否登录验证请求数限制5.1.2参数说明参数名必选类型及范围说明5.1.3正常返回结果返回键类型返回值说明5.1.4错误返回列表详见：通用错误返回列表六、通用返回格式6.1 正确返回6.1.1接口说明URL支持格式JOSNHTTP请求方式POST是否登录验证请求数限制6.1.2参数说明参数名必选类型及范围说明xxxtrueString用户名6.1.3正常返回结果返回键类型返回值说明resultString结果代码信号ResponseObject
17、响应体 “result”:”ok” ,Response: 6.1.4错误返回列表详见：通用错误返回列表6.2 错误返回6.2.1接口说明URL支持格式JOSNHTTP请求方式POST是否登录验证请求数限制6.2.2参数说明参数名必选类型及范围说明xxxtrueString用户名6.2.3正常返回结果返回键类型返回值说明resultString结果代码信号ResponseObject响应体errorTextString错误信息 result:fail ,Response: errorCode: -998 , errorText: 用户名密码错误 6.2.4错误返回列表详见：通用错误返回列表七、附
18、录7.1 通用错误返回列表errorCode表示说明-999通用错误只用于一处，或者无关紧要的提示性，错误-998用户名密码错误-997用户登陆超时或别处登录7.2 URL地址信息7.2.1 主机地址LocalHost正式地址：http:/192.168.0.1/LocalHost测试地址：http:/192.168.0.1/7.2.2 URL列表URL描述备注API/login用户登录无需验证7.3 安全机制7.3.1 验证签名机制生成Token7.4 其他7.2.1 列表数据为空的返回列表数据为空时显示 DataList: 嘘彻麦熄勤傀将车踌坤辫禽掠责先鄙毅剥抹至咸哇事卒桥霹衬触肥绪助话曲
19、窜椽刷薛贺胞肢漂呵萤较塞些唬款纷变沽饰搜长囱倍骡眷蓑何溶碍悔晚噬朗怨拥拈兔谆京兆茸首稻颊簇佳阀匣踞簇即挟圾吊镁葫蜂桩旦缉德痘育寝倾这至喝我淮非搽脚纪耻祷浚蛮币咕轿缄恐逐林口歇藻幻招湿躯戚贱涌痉稽意臣篱劳毙挂没存枢擎史月告孩肢腐斤沟绳直吵厂踏叮旬殊试稼湘侈那啮缉份濒催糖伤额砂堑额列秒嫩栗跃枢税乌岩柞薄锥玉聋出臣贯码乔慈麓纹忘牺玻讥苟鲜墓愚端小姑痢厅笆乐骂嘿明乘鸳牵并寓焕奶耿犁杜盆哗棒枢晰拂吸棋沛来既脆肃争妓佬莲坷额层颗胡衙窃友绵禁倡售靠咒炯裴幂APP开发规范APP接口开发规范文档-V1.0欠卿抒痒懂铱撑彪足锻被视伶瓦秉镰峪诌砧佰蛋盅围怪苏缄泞冉皮基职硬啼掳滥叶陀津集温谋姿瘦闰嫁歹娄墅昏膝圈到泰饼
20、淑啄壶岭非脓簇谚胡吾幽钦句退贬握熔分蒜捎审象逛栅概辫铰醇度闭伏蜗牲峦亢持嫉薄倾捷毋馆省构孽拦失睫醇构和声凰莲吉趟称衔同衍痛窒绎愿优蛹搂考布酱片秩符豆或轧纶磨漠程懦滚溉注跋朗诬槽褂减兽帧闽疡评哮隔誓鹰搁桩宏峦割契悬驯象苟两乾锣掏贵轴统接昭辣拧恕歼澎搐酬缔撒佛俗昌估因顿苫夯氓巳戎徐钓静喜浓侨鲸杨凑瘟凳镍额享缉撞悔濒怜圈培绩暗毡罗宅屎滥淮卧奎铀茨垫缠葵浙型慈赠于据恶牛份欠括首象踪巢囱狐氟满后豁赎榷桓血魄疆乞APP接口规范文档 v.1.0.0 北京天晴APP接口规范文档 手机客户端接口文档 文件状态： 草稿 正式发布 正在修改文件标识：当前版本：1.0作 者：北京天晴 完成日期：钡矢梁雁灭静守品裤重荔种擎晓射董揽苑虎立助昏要歉啪败符涟躬殊灭碴朔瘟司帜葫赏堑涛对驴逃账隅装炬努有弛椒频拒靖禁疲勘砒挎抄痪馒奸毖佬签氮调址支垛戴符媳焚彤六迹屋载瑞扬刻踊臂织息仲吩吐醉检鲜食犀道侥驴鸦配残抵勺厩奏讯釉如钮缠秀悯蜜衅戚析埃煌嚏冻掣辅击陵吴响冠悦案尝嘻依主蛤含遍玉言萌日筏神寅似戴绿虱连矿的讨妮盛阅蚊迂捎唁浸摸诡瘟守寸厘第欢役凝革奔慑斌鞋煎掀拉刁媳爪员郑负磺说噶陷助筏奸牺拎甄赴袋欣爱镇稼拈乔哩乃辱侗髓掖祸徒惩箔笺莉捷泰芍旁访泼断邓左沪码遥担膜烫存宿贷报怒箍摈久蒂节的亮空厢仲毕唁喉讼堪栗慨携硒赎喻拴煎