前后端接口规范

一、基础约定

1、接口路径以 /api 或 /[version]/api 开头

如：/api/users 或 /v2/api/users

2、HTTP方法

方法	场景
GET	获取数据
POST	创建数据
PATCH	差量修改数据
PUT	全量修改数据
DELETE	删除数据

 

 

 

 

 

 

 

3、HTTP状态码 (有很多状态吗，这里只列了少部分)

状态码	说明
200	创建成功
400	参数错误
401	未授权
404	未找到对象
500	服务器错误
502	网关错误

 

 

 

 

 

 

 

 

 

4、数据结构

code: =200 成功， >200 异常
message: 返回信息描述
data: 数据

 

// 成功
{
    "code": 200,
    "message": "success",
    "data": {
        "key": "value"
    }
}

// 分页数据
{
    "code": 200,
    "message": "success",
    "data": {
        "items": [
          {...},
          {...},
        ],
        "total": 10,
　　　　　"currentPage": 1,
    　　 "pageSize": 20,
        "totalPage": 1,
    }
}

// 错误信息
{
    "code": 1000,
    "message": "错误",
    "data": {}
}