目录
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
评论1
最新资源