app接口开发规范方案文档-v1.0

《app接口开发规范方案文档-v1.0》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、{APP接口规范文档}手机客户端接口文档文件状态：[]草稿[√]正式发布[]正在修改文件标识：当前版本：1.0作者：Stone完成日期：版本历史版本/状态作者参与者起止日期备注V1.0/草稿Stone移动小组目录一、概述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参数说

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正常返回

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.2URL列表117.3安全机制117.3.1验证签名机制117.4其他117

4、.2.1列表数据为空的返回11一、概述1.1有关接口1.1.1接口是纯数据的交互APP接口是移动设备和业务之间进行通信的途径。实质就是以特定的规则通过接口直接操作数据库的增删改查。1.2接口的分类1.2.1查询类接口查询类接口是指客户端传递一些参数，服务端根据参数依据需求，前往数据库查询需要的结果返回数据的一类接口。返回类型一般有两种。第一种是返回一个对象，第二种是返回一个数组对象。第一种比如登陆，客户端把用户名密码上传到接口，服务器返回用户的个人信息。第二种比如获取客户，客户端把用户的身份信息上传到接口，服务器返回此身份下的所有客户数组集合。

5、1.2.2操作类接口操作类接口是指，客户端通过接口进行一些增删改的操作。比如新增一个客户，修改客户信息，或者删除一个客户。服务器一般返回执行的状态，有的需要返回执行结果的一些信息，比如新增客户后，返回客户的ID。1.2.3上传下载类接口上传下载类接口是涉及到文件传输的接口。比如上传头像，需要上传图片到服务器，服务端根据需求响应保存并返回结果。比如客户端需要显示用户头像，需要读取网络图片文件，在手机上进行显示。1.2.4推送类接口除了客户端主动去请求服务端，获取需要信息之外。有时候，也存在服务端有消息需要通知客户端的情况，这时候就是服务端向客户端

6、发送消息。这类需求可以通过客户端短时间类循环请求解决，也可以通过第三方专业推送解决。也可以通过自己使用socket或者xmpp等协议进行开发。二、查询类接口格式规范2.1获取单条对象信息2.1.1请求格式URL支持格式JOSNHTTP请求方式POST是否登录验证请求数限制2.1.2参数说明参数名必选类型及范围说明xxxtrueString用户名2.1.3正常返回结果返回键类型返回值说明resultString结果代码信号ok结果成功，fail结果失败ResponseObject响应体Key1int响应字段值Key2String响应字段值Key3

7、Object响应字段值可以依然包含对象体Key3_Key1int响应字段值{"result":"ok","Response":{"userName":"Mary","sex":1,"Address":[{"city":"JiNan"},{"county":"LiXia"}]}}2.1.4错误返回列表详见：通用错误返回列表2.2获取列表对象信息2.2.1请求格式URL支持格式JOSNHTTP请求方式POST是否登录验证请求数限制2.2.2参数说明参数名必选类型及范围说明xxxtrueString用户名Pagefalseint第几页，不传递默认第一

8、页Sizefalseint一页多少条，不传递默认20条2.2.3正常返回结果返回键类型返回值说明resultString结果代码信号ResponseO