通用接口, 得有 一定的 格式比如:
请求参数说明:例如 {appKey:123,userToken:”xx”,v:1.0,jsonString:”xx”,sign:”123”}
jsonString
返回值 类型JSON
JSON内容 | 说明 | ||
result | 0 int 系统异常 2 令牌失效
| ||
message | 状态说明信息 (String) | ||
data | key | 类型 | 说明 |
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
开发接口的过程中, 不要相信,产品,不要 相信 数据库表 设计者,都泪啊。尽量做到 nullpoint 空指针的异常判断,就算没有数据,也尽量 返回 空字符串给 app.或者是 有默认值,不要这样子来:比如
data | key | 类型 | 说明 |
| total | int | 消息总数 |
|
| total 大于0才有下面 |
|
| messages | json | Key: 下面是值 |
| msgId | int | 主键 |
| title | string | 标题 |
| time | string | 时间 |
| content | Sting | 消息内容 |
不要这样,比如 total >0 下面才有 ,数据,这样 对以后 写 dto 或者是 vo ,都不好啊,应该是 一个 bean的类型,而且 对于 app端的 封装 接收数据什么的 都是很不方便的