经验分享-API接口响应格式规范定义
来源:互联网 发布:固定音高训练 软件 编辑:程序博客网 时间:2024/06/06 09:20
俗话说无规矩不成方圆,一个接口一种数据响应格式,一个开发人员一种开发格式,导致代码不规范,数据解析复杂化,维护更是难上加难。
1.关于接口响应数据格式参考[json格式],做到不使用的属性不返回
基础响应格式【其他格式在此格式上进行扩展】
{
"code":100,
"msg":"ok",
}
对象格式【对象数据存在】【对象数据不存在,使用基础响应格式】
e:个人信息为例
{
"code":100,
"msg":"ok",
"data":{
"id":100,
"name":"小伟",
"age":20,
"sex":0
}
}
数组格式【数组可以对象数组,字符数组】【数组不存在,使用基础响应格式】
{
"code":100,
"msg":"ok",
"data":[
{
"id":1,
"name":"小王",
"age":10
},
{
"id":1,
"name":"小王",
"age":10
}
]
}
分页列表格式【分页结果】【分页数据不存在,使用基础响应格式】
{
"code":100,
"msg":"ok",
"data":{
"nowPage":1,
"totalPage":10,
"list":[
{
"id":1,
"name":"小王",
"age":10
},
{
"id":1,
"name":"小王",
"age":10
}
]
}
}
按照以上的划分,是可归为一类型对象类型,data可以为是数组,自定义对象,分页对象,使用Java作为开发语言,可以直接定义一个请求响应泛型类,
e:基础解析类
public class ReqBase { /**响应码*/ public int code; /**响应码相关提示信息*/ public int msg; }对象响应泛型类型
public class ReqObjectT<T> extends ReqBase{ /**数据*/ public T data;}
接口响应数据格式中,图片地址必须给出完整的地址
e:{
"code":100,
"msg":"ok",
"data":[
"http://xxx/file/upliad/20172514.jpg",
"http://xxx/file/upliad/20172515.jpg"
]
}
- 经验分享-API接口响应格式规范定义
- 前后端接口规范-------通用响应格式3
- RESTful api接口规范
- restfull api 接口 规范
- API接口规范
- 系统API接口规范
- restful API接口规范
- API 接口开发规范
- Restful Api接口规范
- HTTP API响应数据规范
- 免费api接口分享
- Facebook API使用经验分享
- 远程接口设计经验分享
- RestFul Api 定义流程规范
- RestFul Api 定义流程规范
- C#接口定义学习经验
- 接口定义和SOA规范
- 【分享经验】手机话费充值接口接入指南(含话费API说明)
- HTML5 进阶系列:canvas 动态图表
- JS(九)事件处理
- Qin Shi Huang's National Road System
- 采集破解防盗链图片显示的方法
- PCL编程多个点云合成
- 经验分享-API接口响应格式规范定义
- 对预编译头文件的理解(转载)
- JAVA异常入门
- centos6.8 tomcat无法停止 并报报8005端口连接不上的问题
- Vue.js 插件开发详解
- Spring发展历程总结
- 夽互联解决方案
- 蓝桥杯第六届决赛:胡同门牌号
- P1055 ISBN号码