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

天晴APP接口规文档手机客户端接口文档文件状态： 草稿 正式发布 正在修改文件标识：当前版本：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接口说明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正常返回结果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.2URL地址信息117.2.1主机地址117.2.2 URL列表117.3安全机制117.3.1验证签名机制117.4其他117.2.1列表数据为空的返回1112 / 16一、概述1.1 有关接口1.1.1接口是纯数据的交互APP接口是移动设备和业务之间进行通信的途径。实质就是以特定的规则通过接口直接操作数据库的增删改查。1.2 接口的分类1.2.1查询类接口查询类接口是指客户端传递一些参数，服务端根据参数依据需求，前往数据库查询需要的结果返回数据的一类接口。返回类型一般有两种。第一种是返回一个对象，第二种是返回一个数组对象。第一种比如登陆，客户端把用户名密码上传到接口，服务器返回用户的个人信息。第二种比如获取客户，客户端把用户的身份信息上传到接口，服务器返回此身份下的所有客户数组集合。1.2.2 操作类接口操作类接口是指，客户端通过接口进行一些增删改的操作。比如新增一个客户，修改客户信息，或者删除一个客户。服务器一般返回执行的状态，有的需要返回执行结果的一些信息，比如新增客户后，返回客户的ID。1.2.3上传下载类接口上传下载类接口是涉与到文件传输的接口。比如上传头像，需要上传图片到服务器，服务端根据需求响应保存并返回结果。比如客户端需要显示用户头像，需要读取网络图片文件，在手机上进行显示。1.2.4推送类接口除了客户端主动去请求服务端，获取需要信息之外。有时候，也存在服务端有消息需要通知客户端的情况，这时候就是服务端向客户端发送消息。这类需求可以通过客户端短时间类循环请求解决，也可以通过第三方专业推送解决。也可以通过自己使用socket或者xmpp等协议进行开发。二、查询类接口格式规2.1获取单条对象信息2.1.1 请求格式URL支持格式JOSN 请求方式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错误返回列表详见：通用错误返回列表2.2获取列表对象信息2.2.1 请求格式URL支持格式JOSN 请求方式POST是否登录验证请求数限制2.2.2参数说明参数名必选类型与围说明xxxtrueString用户名Pagefalseint第几页，不传递默认第一页Sizefalseint一页多少条，不传递默认20条2.2.3正常返回结果返回键类型返回值说明resultString结果代码信号ResponseObject响应体LastUpdateTimeString 最后一条更新时间根据此时间判断新旧 ThisPageNumber int 当前页条数判断是否为空，是否有下页 DataList ArrayObject 对象列表时间倒序排列 “result”:”ok” , Response: LastUpdateTime: 2012-12-11 22:01:09, ThisPageNumber: 2, DataList: id: 1, date: 2014-07-24, detail: , points: 50 , id: 2, date: 2014-07-24, detail: , points: 50 2.2.4错误返回列表详见：通用错误返回列表三、操作类接口3.1 新增操作3.1.1接口说明URL支持格式JOSN 请求方式POST是否登录验证请求数限制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支持格式JOSN 请求方式POST是否登录验证请求数限制3.2.2参数说明参数名必选类型与围说明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支持格式JOSN 请求方式POST是否登录验证请求数限制3.3.2参数说明参数名必选类型与围说明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支持格式JOSN 请求方式POST是否登录验证请求数限制4.1.2参数说明参数名必选类型与围说明xxxtrueString用户名xxxtrueFile值为文件类型，处理同Web中的表单FILE一样4.1.3正常返回结果返回键类型返回值说明resultString结果代码信号ResponseObject响应体filePathString文件存放的绝对路径上传 “result”:”ok” , Response: filePath: .baidu./logo.gif 4.1.4错误返回列表详见：通用错误返回列表4.2下载文件4.2.1接口说明URL支持格式JOSN 请求方式POST是否登录验证请求数限制4.2.2参数说明参数名必选类型与围说明xxxtrueString文件网络绝对路径4.2.3正常返回结果返回键类型返回值说明确保文件可以正常访问下载4.2.4错误返回列表详见：通用错误返回列表五、推送类接口5.1 推送消息5.1.1接口说明URL支持格式JOSN 请求方式POST是否登录验证请求数限制5.1.2参数说明参数名必选类型与围说明5.1.3正常返回结果返回键类型返回值说明5.1.4错误返回列表详见：通用错误返回列表六、通用返回格式6.1 正确返回6.1.1接口说明URL支持格式JOSN 请求方式POST是否登录验证请求数限制6.1.2参数说明参数名必选类型与围说明xxxtrueString用户名6.1.3正常返回结果返回键类型返回值说明resultString结果代码信号ResponseObject响应体 “result”:”ok” ,Response: 6.1.4错误返回列表详见：通用错误返回列表6.2错误返回6.2.1接口说明URL支持格式JOSN 请求方式POST是否登录验证请求数限制6.2.2参数说明参数名必选类型与围说明xxxtrueString用户名6.2.3正常返回结果返回键类型返回值说明resultString结果代码信号ResponseObject响应体errorTextString错误信息 result:fail ,Response: errorCode: -998 , errorText: 用户名密码错误 6.2.4错误返回列表详见：通用错误返回列表七、附录7.1 通用错误返回列表errorCode表示说明-999通用错误只用于一处，或者无关紧要的提示性，错误-998用户名密码错误-997用户登陆超时或别处登录7.2URL地址信息7.2.1 主机地址LocalHost正式地址：192.168.0.1/LocalHost测试地址：192.168.0.1/7.2.2 URL列表URL描述备注API/login用户登录无需验证7.3安全机制7.3.1 验证签名机制生成Token7.4其他7.2.1 列表数据为空的返回列表数据为空时显示 DataList: 1. 若不给自己设限，则人生中就没有限制你发挥的藩篱。2. 若不是心宽似海，哪有人生风平浪静。在纷杂的尘世里，为自己留下一片纯静的心灵空间，不管是潮起潮落，也不管是阴晴圆缺，你都可以免去浮躁，义无反顾，勇往直前，轻松自如地走好人生路上的每一步3. 花一些时间，总会看清一些事。用一些事情，总会看清一些人。有时候觉得自己像个神经病。既纠结了自己，又打扰了别人。努力过后，才知道许多事情，坚持坚持，就过来了。4. 岁月是无情的，假如你丢给它的是一片空白，它还给你的也是一片空白。岁月是有情的，假如你奉献给她的是一些色彩，它奉献给你的也是一些色彩。你必须努力，当有一天蓦然回首时，你的回忆里才会多一些色彩斑斓，少一些苍白无力。只有你自己才能把岁月描画成一幅难以忘怀的人生画卷。