一.接口规则
我们在开发APP或者web网页过程中一般有前端，后台两类程序员；
后台负责业务逻辑，前端负责UI和展现后台的业务逻辑；
通常前端和后台的交流通过约定好的数据格式进行交流-这约定的格式通常由后台制定；
但是一个好的接口规则势必让调试事半功倍；
以App开发为例，通常后台有规则有如下，必定返回字段，定义基础信息code，识别码。识别码对应的提示信息msg，定义具体的信息业务信息data，data中一般不能为null，有字符串，对象，数组,对象3钟方式返回，当然格式可以变化随业务逻辑变化而变化！
1.后台可以优雅的抽象一个响应业务逻辑基类
/**
* @ClassName: CommonResponse
* @Description: 返回信息类
* @author lirain
* @date 2016年10月18日 上午11:45:06
*
*/
public class CommonResponse {
private Integer code; //返回码
private String msg; //返回提示信息
private Object data; //返回数据
public Integer getCode() {
return code;
}
public void setCode(Integer code) {
this.code = code;
}
public String getMsg() {
return msg;
}
public void setMsg(String msg) {
this.msg = msg;
}
public Object getData() {
return data;
}
public void setData(Object data) {
this.data = data;
}
}
2.返回类型基本也就按规则固定下来了
//返回类型一：对象
{
"code": 0,
"msg": "成功",
"data": {
"id": 1,
"name": "李先生",
"tel": "15200000000"
}
//返回类型二：数组
{
"code": 0,
"msg": "成功",
"data": [
{
"id": 1,
"name": "李先生",
"tel": "15200000000"
},
{
"id": 2,
"name": "张先生",
"tel": "15200000001"
}
]
}
//返回类型三：字符串--一般操作很少这样用
{
"code": 0,
"msg": "成功",
"data":""
}
//一般后台约定成功的code都为0，失败为1，异常为-1，其余业务逻辑码，视情况而定，
//没有具体业务逻辑返回时，一般为空对象或数组，避免null这类空返回
//后面将说道，这样约定的好处！
{
"code": 1,
"msg": "用户不存在",
"data":{}
}
//异常提示
{
"code": -1,
"msg": "服务器消息异常",
"data":{}
}
3.通过这种规范化约定后，前端也能定义一个基础类，保持code，msg，data，3个字段不变，其中data定义为泛型；以android代码为例，代码表述如下，
**
* Created by lichuanbei on 2017/8/1.
*
* 功能描述：接口调用返回数据标准格式基类
*/
public class BaseResponseEntity{
private int code;
private String msg;
private T data;
public int getCode() {
return code;
}
public void setCode(int code) {
this.code = code;
}
public String getMsg() {
return msg;
}
public void setMsg(String msg) {
this.msg = msg;
}
public T getData() {
return data;
}
public void setData(T data) {
this.data = data;
}
}
用户基本信息返回对象为
/**
* Created by lichuanbei on 2017/8/1.
*
* 功能描述：用户基础类
*/
public class UserEntity {
private String id;
private String name;
private String tel;
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getTel() {
return tel;
}
public void setTel(String tel) {
this.tel = tel;
}
}
4.最终当前端调用登录接口返回用户信息时，逻辑有resuful风格设计代码接口表述：注意接口中的BaseResponseEntity
/**
* 登录接口
* mobile必传 password必传
* @param map
* @return
*/
@FormUrlEncoded
@POST("/user/login")
Observable> login(@FieldMap Map map);
二.对接口的测试
1.接口一旦确定后，后台必定会有基础测试，通过后，则直接交给前端处理展示;