基于《从客户端的角度设计后端的接口》设计的客户端接口模板文档。

公共信息

域名url

开发环境：http://www.online.com/api
测试环境：http://www.test.com/api

请求Path

http://www.xxx.com/api/ [path]

基础规范

示例（见名知意）

请求头参数

响应code

响应参数格式

• object类型数据

// json
{
  "code":200,
  "msg":"成功",
  "time":"1482213602000",
  "data": {
    "name":"张三",
    "age":"20"
  }
}  
     
// model.java
public class Model {
     public String name;
     public String age;
} 

• Array类型数据

// json
{
    "code":200,
    "msg":"成功",
    "time":"1482213602000",
    "data": {
        "list":["张三","李四"]
    }
}   
  
// model.java
public class Model {
    public List<String> list;
} 

• 分页类型数据

// json
{
    "code":200,
    "msg":"成功",
    "time":"1482213602000",
    "data": {
        "list":["张三","李四"],
        "total":"10"
    }
}   
  
// model.java
public class Model {
    public List<String> list;
    public String total;
} 

• 错误类型数据

// json
{
    "code":401,
    "msg":"登录过期",
    "time":"1482213602000",
    "data": {}
}   

备注

1.请求，应答参数，一律使用驼峰命名，例：firstInviteTime
2.数据获取型接口使用GET，提交型接口使用POST
3.字段说明信息要清晰，完整，例：[1：待支付，2：待支付，3:已完成]
4.金额，时间字段要备注单位，例：(租车时间，单位：毫秒，优惠时长，单位：分钟)
5.boolean型数据，统一采用"isSelect","isCheck"，以"is"开头，数据返回，1:是，0:否
6.相同的业务字段，尽量不要使用不同的字段名称，例如：行程ID，不要出现"tripId"，"trip_id"多个版本。在进行字段命名的时候可以看下其他接口是否有相同字段

登录相关

登陆

通过账号+密码进行登录

接口

请求参数

应答参数

示例

{
  "code":200,
  "msg":"成功",
  "time":"1482213602000",
  "data": {
    "token":"202cb962ac59075b964b07152d234b70"
  }
}

账号相关

忘记密码

根据手机号+短信验证码进行密码重置

接口

请求参数

应答参数

示例

{
  "code":200,
  "msg":"成功",
  "time":"1482213602000",
  "data": {}
}

修改密码

根据旧密码，重新设置新密码

接口

请求参数

应答参数

示例

{
  "code":200,
  "msg":"成功",
  "time":"1482213602000",
  "data": {}
}

其他具体业务接口可以参考以上格式，举一反三...