API接口响应格式规范定义.pdf

AAPPII接接 ⼝⼝响响应应格格式式规规范范定定义义 俗俗话话说说⽆⽆规规矩矩不不成成⽅⽅ 圆圆 ，，⼀⼀个个接接 ⼝⼝⼀⼀种种数数据据响响应应格格式式 ，，⼀⼀个个开开发发⼈⼈ ⼀⼀种种 开开发发格格式式 ，，导导致致代代码码不不规规 范范 ，，数数据据解解析析复复杂杂化化 ，，维维护护更更是是难难上上加加难难 。。 ⼀⼀、、接接 ⼝⼝响响应应数数据据格格式式 ，，做做 到到不不使使⽤⽤ 的的属属性性不不返返 回回 11、、基基础础 响响应应格格式式 【【其其他他 格格式式在在此此格格式式上上进进⾏⾏扩扩展展】】 { code:200, msg:ok, } 22、、对对象象格格式式 以以个个⼈⼈信信息息为为例例 { code:200, msg:ok, data:{ id:100, name:poppy, age:20, sex:1 } } 33 、、数数组组格格式式通通 常常为为列列表表 { code:200, msg:ok, data:[{ id:1, name:poppy, age:20 },{ id:2, name:thorn, age:18 }] } 44 、、分分页页列列表表格格式式 { code:200, msg:ok, data:{ now Page:1, tota Page:10, ist:[ { id:1, name:poppy, age:20 }, { id:2, name:thorn, age:18 } ] } } 55、、接接 ⼝⼝响响应应数数据据格格式式 中中，，图图⽚⽚地地址址必必须须给给 出出完完整整 的的地地址址 { code:200, msg:ok, data:[ http://xxx/fi e/up iad/201725 14.j pg, http://xxx/fi e/up iad/201725 15.j pg ] } ⼆⼆、、接接 ⼝⼝协协商商要要点点 11、、接接 ⼝⼝必必须须返返 回回统统⼀⼀的的数数据据结结构构 ,, 参参考考 【【接接 ⼝⼝响响应应数数据据格格式式结结构构】】 22、、接接 ⼝⼝查查询询不不到到数数据据时时,, 即即空空数数据据 的的情情况况下下返返 回回给给前前端端怎怎样样 的的数数据据 建议返回⾮ null 的对应数据类型初始值, 例如对象类型的返回空对象({}), 数组类型的返回空数组([]), 其他原始数据类型 (string/number/boolean...)也使⽤对应的默认值 这样可以减少前端很多琐碎的⾮空判断, 直接使⽤接⼝中的数据 33 、、返返 回回数数据据 中中图图⽚⽚ UURRLL 需需要要完完整整路路径径 44 、、返返 回回数数据据 中中页页⾯⾯跳跳转转 的的 UURRLL 是