实例介绍
APP接口开发规范文档-V1.0，java接口开发规范 查询类接口是指客户端传递一些参数，服务端根据参数依据需求，前往数据库查询需要的结果返回数据的一类接口。 返回类型一般有两种。第一种是返回一个对象，第二种是返回...
【实例截图】
【核心代码】
目录
软件规范文档 PAGEREF _Toc19797326 \h 1
一、概述 PAGEREF _Toc19797327 \h 1
1.1 有关接口 PAGEREF _Toc19797328 \h 1
1.1.1接口是纯数据的交互 PAGEREF _Toc19797329 \h 1
1.2 接口的分类 PAGEREF _Toc19797330 \h 1
1.2.1查询类接口 PAGEREF _Toc19797331 \h 1
1.2.2 操作类接口 PAGEREF _Toc19797332 \h 1
1.2.3上传下载类接口 PAGEREF _Toc19797333 \h 1
1.2.4推送类接口 PAGEREF _Toc19797334 \h 2
二、查询类接口格式规范 PAGEREF _Toc19797335 \h 2
2.1获取单条对象信息 PAGEREF _Toc19797336 \h 2
2.1.1 请求格式 PAGEREF _Toc19797337 \h 2
2.1.2参数说明 PAGEREF _Toc19797338 \h 2
2.1.3正常返回结果 PAGEREF _Toc19797339 \h 2
2.2获取列表对象信息 PAGEREF _Toc19797340 \h 3
2.2.1 请求格式 PAGEREF _Toc19797341 \h 3
2.2.2参数说明 PAGEREF _Toc19797342 \h 3
2.2.3正常返回结果 PAGEREF _Toc19797343 \h 4
三、操作类接口 PAGEREF _Toc19797344 \h 5
3.1 新增操作 PAGEREF _Toc19797345 \h 5
3.1.1接口说明 PAGEREF _Toc19797346 \h 5
3.1.2参数说明 PAGEREF _Toc19797347 \h 5
3.1.3正常返回结果 PAGEREF _Toc19797348 \h 5
3.1.4错误返回列表 PAGEREF _Toc19797349 \h 6
3.2 修改操作 PAGEREF _Toc19797350 \h 6
3.2.1接口说明 PAGEREF _Toc19797351 \h 6
3.2.2参数说明 PAGEREF _Toc19797352 \h 6
3.2.3正常返回结果 PAGEREF _Toc19797353 \h 6
3.2.4错误返回列表 PAGEREF _Toc19797354 \h 7
3.3 删除操作 PAGEREF _Toc19797355 \h 7
3.3.1接口说明 PAGEREF _Toc19797356 \h 7
3.3.2参数说明 PAGEREF _Toc19797357 \h 7
3.3.3正常返回结果 PAGEREF _Toc19797358 \h 7
3.3.4错误返回列表 PAGEREF _Toc19797359 \h 8
四、上传下载类 PAGEREF _Toc19797360 \h 8
4.1 上传文件 PAGEREF _Toc19797361 \h 8
4.1.1接口说明 PAGEREF _Toc19797362 \h 8
4.1.2参数说明 PAGEREF _Toc19797363 \h 8
4.1.3正常返回结果 PAGEREF _Toc19797364 \h 8
4.1.4错误返回列表 PAGEREF _Toc19797365 \h 9
4.2 下载文件 PAGEREF _Toc19797366 \h 9
4.2.1接口说明 PAGEREF _Toc19797367 \h 9
4.2.2参数说明 PAGEREF _Toc19797368 \h 9
4.2.3正常返回结果 PAGEREF _Toc19797369 \h 10
4.2.4错误返回列表 PAGEREF _Toc19797370 \h 10
五、推送类接口 PAGEREF _Toc19797371 \h 10
5.1 推送消息 PAGEREF _Toc19797372 \h 10
5.1.1接口说明 PAGEREF _Toc19797373 \h 10
5.1.2参数说明 PAGEREF _Toc19797374 \h 10
5.1.3正常返回结果 PAGEREF _Toc19797375 \h 11
5.1.4错误返回列表 PAGEREF _Toc19797376 \h 11
六、通用返回格式 PAGEREF _Toc19797377 \h 11
6.1 正确返回 PAGEREF _Toc19797378 \h 11
6.1.1接口说明 PAGEREF _Toc19797379 \h 11
6.1.2参数说明 PAGEREF _Toc19797380 \h 11
6.1.3正常返回结果 PAGEREF _Toc19797381 \h 12
6.1.4错误返回列表 PAGEREF _Toc19797382 \h 12
6.2 错误返回 PAGEREF _Toc19797383 \h 12
6.2.1接口说明 PAGEREF _Toc19797384 \h 12
6.2.2参数说明 PAGEREF _Toc19797385 \h 13
6.2.3正常返回结果 PAGEREF _Toc19797386 \h 13
6.2.4错误返回列表 PAGEREF _Toc19797387 \h 13
七、附录 PAGEREF _Toc19797388 \h 13
7.1 通用错误返回列表 PAGEREF _Toc19797389 \h 13
7.2 URL地址信息 PAGEREF _Toc19797390 \h 14
7.2.1 主机地址 PAGEREF _Toc19797391 \h 14
7.2.2 URL列表 PAGEREF _Toc19797392 \h 14
7.3 安全机制 PAGEREF _Toc19797393 \h 14
7.3.1 验证签名机制 PAGEREF _Toc19797394 \h 14
相关软件
小贴士
感谢您为本站写下的评论，您的评论对其它用户来说具有重要的参考价值，所以请认真填写。
- 类似“顶”、“沙发”之类没有营养的文字，对勤劳贡献的楼主来说是令人沮丧的反馈信息。
- 相信您也不想看到一排文字/表情墙，所以请不要反馈意义不大的重复字符，也请尽量不要纯表情的回复。
- 提问之前请再仔细看一遍楼主的说明，或许是您遗漏了。
- 请勿到处挖坑绊人、招贴广告。既占空间让人厌烦，又没人会搭理，于人于己都无利。
关于好例子网
本站旨在为广大IT学习爱好者提供一个非营利性互相学习交流分享平台。本站所有资源都可以被免费获取学习研究。本站资源来自网友分享，对搜索内容的合法性不具有预见性、识别性、控制性，仅供学习研究，请务必在下载后24小时内给予删除，不得用于其他任何用途，否则后果自负。基于互联网的特殊性，平台无法对用户传输的作品、信息、内容的权属或合法性、安全性、合规性、真实性、科学性、完整权、有效性等进行实质审查；无论平台是否已进行审查，用户均应自行承担因其传输的作品、信息、内容而可能或已经产生的侵权或权属纠纷等法律责任。本站所有资源不代表本站的观点或立场，基于网友分享，根据中国法律《信息网络传播权保护条例》第二十二与二十三条之规定，若资源存在侵权或相关问题请联系本站客服人员，点此联系我们。关于更多版权及免责申明参见 版权及免责申明
网友评论
我要评论