没有合适的资源?快使用搜索试试~ 我知道了~
首页java api接口规范
资源详情
资源推荐
Java 接口规范文档
目录
Java 接口规范文档......................................................................................................................... 1
一、概述........................................................................................................................................ 1
1.1 有关接口.......................................................................................................................... 1
1.1.1 接口是纯数据的交互............................................................................................1
1.2 接口的分类...................................................................................................................... 1
1.2.1 查询类接口............................................................................................................ 1
1.2.2 操作类接口............................................................................................................ 1
1.2.3 上传下载类接口.................................................................................................... 1
1.2.4 推送类接口............................................................................................................ 2
二、查询类接口格式规范............................................................................................................. 2
2.1 获取单条对象信息........................................................................................................... 2
2.1.1 请求格式............................................................................................................... 2
2.1.2 参数说明................................................................................................................ 2
2.1.3 正常返回结果........................................................................................................ 2
2.2 获取列表对象信息........................................................................................................... 4
2.2.1 请求格式............................................................................................................... 4
2.2.2 参数说明................................................................................................................ 4
2.2.3 正常返回结果........................................................................................................ 4
三、操作类接口............................................................................................................................ 5
3.1 新增操作.......................................................................................................................... 5
3.1.1 接口说明................................................................................................................ 5
3.1.2 参数说明................................................................................................................ 6
3.1.3 正常返回结果........................................................................................................ 6
3.1.4 错误返回列表........................................................................................................ 7
3.2 修改操作.......................................................................................................................... 7
3.2.1 接口说明................................................................................................................ 7
3.2.2 参数说明................................................................................................................ 7
3.2.3 正常返回结果........................................................................................................ 7
3.2.4 错误返回列表........................................................................................................ 8
3.3 删除操作.......................................................................................................................... 8
3.3.1 接口说明................................................................................................................ 8
3.3.2 参数说明................................................................................................................ 8
3.3.3 正常返回结果........................................................................................................ 8
3.3.4 错误返回列表........................................................................................................ 9
四、上传下载类............................................................................................................................ 9
4.1 上传文件.......................................................................................................................... 9
4.1.1 接口说明................................................................................................................ 9
4.1.2 参数说明................................................................................................................ 9
4.1.3 正常返回结果...................................................................................................... 10
4.1.4 错误返回列表...................................................................................................... 10
4.2 下载文件........................................................................................................................ 10
4.2.1 接口说明.............................................................................................................. 10
4.2.2 参数说明.............................................................................................................. 11
4.2.3 正常返回结果...................................................................................................... 11
4.2.4 错误返回列表...................................................................................................... 11
五、推送类接口.......................................................................................................................... 11
5.1 推送消息........................................................................................................................ 11
5.1.1 接口说明.............................................................................................................. 12
5.1.2 参数说明.............................................................................................................. 12
5.1.4 错误返回列表...................................................................................................... 12
六、通用返回格式...................................................................................................................... 12
6.1 正确返回........................................................................................................................ 12
6.1.1 接口说明.............................................................................................................. 13
6.1.2 参数说明.............................................................................................................. 13
6.1.3 正常返回结果...................................................................................................... 13
6.1.4 错误返回列表...................................................................................................... 14
6.2 错误返回........................................................................................................................ 14
6.2.1 接口说明.............................................................................................................. 14
6.2.2 参数说明.............................................................................................................. 14
6.2.3 正常返回结果...................................................................................................... 15
6.2.4 错误返回列表...................................................................................................... 15
七、附录...................................................................................................................................... 15
7.1 通用错误返回列表......................................................................................................... 16
7.2 URL 地址信息................................................................................................................. 16
7.2.1 主机地址............................................................................................................. 16
7.2.2 URL 列表.............................................................................................................. 16
7.3 安全机制........................................................................................................................ 16
7.3.1 验证签名机制...................................................................................................... 16
7.4 其他................................................................................................................................ 17
7.4.1 列表数据为空的返回.......................................................................................... 17
1
一、概述
1.1 有关接口
1.1.1 接口是纯数据的交互
接口是视图和业务之间进行通信的途径。实质就是以特定的规则通过接口直接
操作数据库的增删改查。
1.2 接口的分类
1.2.1 查询类接口
查询类接口是指客户端传递一些参数,服务端根据参数依据需求,前往数据库
查询需要的结果返回数据的一类接口。
返回类型一般有两种。第一种是返回一个对象,第二种是返回一个数组对象。
第一种比如登陆,客户端把用户名密码上传到接口,服务器返回用户的个人信
息。
第二种比如获取客户,客户端把用户的身份信息上传到接口,服务器返回此身
份下的所有客户数组集合。
1.2.2操作类接口
操作类接口是指,客户端通过接口进行一些增删改的操作。比如新增一个客户,
修改客户信息,或者删除一个客户。服务器一般返回执行的状态,有的需要返
回执行结果的一些信息,比如新增客户后,返回客户的 ID。
1.2.3 上传下载类接口
剩余19页未读,继续阅读
灬丨路在何方
- 粉丝: 9
- 资源: 21
上传资源 快速赚钱
- 我的内容管理 收起
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
会员权益专享
最新资源
- zigbee-cluster-library-specification
- JSBSim Reference Manual
- c++校园超市商品信息管理系统课程设计说明书(含源代码) (2).pdf
- 建筑供配电系统相关课件.pptx
- 企业管理规章制度及管理模式.doc
- vb打开摄像头.doc
- 云计算-可信计算中认证协议改进方案.pdf
- [详细完整版]单片机编程4.ppt
- c语言常用算法.pdf
- c++经典程序代码大全.pdf
- 单片机数字时钟资料.doc
- 11项目管理前沿1.0.pptx
- 基于ssm的“魅力”繁峙宣传网站的设计与实现论文.doc
- 智慧交通综合解决方案.pptx
- 建筑防潮设计-PowerPointPresentati.pptx
- SPC统计过程控制程序.pptx
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功