APP开发规范APP接口开发规范文档 V10Word格式文档下载.docx
- 文档编号:17197445
- 上传时间:2022-11-28
- 格式:DOCX
- 页数:15
- 大小:18.91KB
APP开发规范APP接口开发规范文档 V10Word格式文档下载.docx
《APP开发规范APP接口开发规范文档 V10Word格式文档下载.docx》由会员分享,可在线阅读,更多相关《APP开发规范APP接口开发规范文档 V10Word格式文档下载.docx(15页珍藏版)》请在冰豆网上搜索。
韩磊
移动小组
一、概述
1.1有关接口
APP接口是移动设备和业务之间进行通信的途径。
实质就是以特定的规则通过接口直接操作数据库的增删改查。
1.2接口的分类
查询类接口是指客户端传递一些参数,服务端根据参数依据需求,前往数据库查询需要的结果返回数据的一类接口。
返回类型一般有两种。
第一种是返回一个对象,第二种是返回一个数组对象。
第一种比如登陆,客户端把用户名密码上传到接口,服务器返回用户的个人信息。
第二种比如获取客户,客户端把用户的身份信息上传到接口,服务器返回此身份下的所有客户数组集合。
1.2.2操作类接口
操作类接口是指,客户端通过接口进行一些增删改的操作。
比如新增一个客户,修改客户信息,或者删除一个客户。
服务器一般返回执行的状态,有的需要返回执行结果的一些信息,比如新增客户后,返回客户的ID。
上传下载类接口是涉及到文件传输的接口。
比如上传头像,需要上传图片到服务器,服务端根据需求响应保存并返回结果。
比如客户端需要显示用户头像,需要读取网络图片文件,在手机上进行显示。
除了客户端主动去请求服务端,获取需要信息之外。
有时候,也存在服务端有消息需要通知客户端的情况,这时候就是服务端向客户端发送消息。
这类需求可以通过客户端短时间类循环请求解决,也可以通过第三方专业推送解决。
也可以通过自己使用socket或者xmpp等协议进行开发。
二、查询类接口格式规范
2.1获取单条对象信息
2.1.1请求格式
URL
支持格式
JOSN
HTTP请求方式
POST
是否登录验证
请求数限制
参数名
必选
类型及范围
说明
xxx
true
String
用户名
返回键
类型
返回值
result
结果代码信号
ok结果成功,fail结果失败
Response
Object
响应体
Key1
int
响应字段值
Key2
String
Key3
Object
可以依然包含对象体
Key3_Key1
int
{
"
result"
:
"
ok"
Response"
{
userName"
Mary"
sex"
1,
Address"
[
city"
JiNan"
},
county"
LiXia"
}
]
}
详见:
通用错误返回列表
2.2获取列表对象信息
2.2.1请求格式
Page
false
第几页,不传递默认第一页
Size
一页多少条,不传递默认20条
LastUpdateTime
最后一条更新时间
根据此时间判断新旧
ThisPageNumber
当前页条数
判断是否为空,是否有下页
DataList
Array[Object]
对象列表
时间倒序排列
“result”:
”ok”,
LastUpdateTime"
2012-12-1122:
01:
09"
ThisPageNumber"
2,
DataList"
id"
date"
2014-07-24"
detail"
points"
50
三、操作类接口
3.1新增操作
id
增数据的ID或者标志
text
操作提示语
如添加客户成功,可为空
text"
3.2修改操作
数据的ID或者标志
如修改客户成功,可为空
3.3删除操作
如删除客户成功,可为空
亲,删除客户成功"
四、上传下载类
4.1上传文件
File
值为文件类型,处理同Web中的表单FILE一样
filePath
文件存放的绝对路径
上传
filePath"
4.2下载文件
文件网络绝对路径
确保文件可以正常访问下载
五、推送类接口
5.1推送消息
六、通用返回格式
6.1正确返回
6.2错误返回
errorText
错误信息
fail"
errorCode"
-998,
errorText"
用户名密码错误"
七、附录
7.1通用错误返回列表
errorCode
表示
-999
通用错误
只用于一处,或者无关紧要的提示性,错误
-998
用户名密码错误
-997
用户登陆超时或别处登录
7.2URL地址信息
7.2.1主机地址
LocalHost正式地址:
.1/
LocalHost测试地址:
7.2.2URL列表
描述
API/login
用户登录
无需验证
7.3安全机制
7.3.1验证签名机制
生成Token
7.4其他
7.2.1列表数据为空的返回
列表数据为空时显示"
[]
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- APP开发规范APP接口开发规范文档 V10 APP 开发 规范 接口 文档