JAVA接口规范.doc

【例子介绍】JAVA接口规范.doc
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

7.4 其他  PAGEREF _Toc19797395 \h 14

7.4.1 列表数据为空的返回  PAGEREF _Toc19797396 \h 14