高效的接口格式

发表于   |  

所谓高效是指前后端通过遵循共同的接口格式规定，这样前后端可以同时进行开发，前端开发者只专注于开发自己程序，模拟接口格式，提前写好逻辑。提高开发效率，同时让接口更具有可读性。
嗯，废话不多说啦，可能刚开始实施可能会有点不习惯，但有利于提高工作效率，可以让你提前下班哦，何乐而不为。GO,GO,GO…

注意： 如无特殊情况，所有接口都要支持jsonp

接口文档

1. 接口说明

简单描述接口的作用

2. 接口链接 (url)

3. 使用的HTTP Method (GET, POST)

4. 入参

前端请求接口带的参数
名称、类型、格式
如：pageNo(Number): 请求的页数

5. 返回格式

1
2
3
4
5
6
7
8
9
10
{
	"status": 200,
	"msg": "成功",
	"data": {
        "banner": {
            "imgurl": "http://me.yy.com",
            "desc": "来ME看鹿晗直播"
        }
    }
}

5.1 对返回的数据说明

字段 说明 类型 可空？ 备注
status 状态码 Number N 成功默认是200，其他状态视需求定，例如
200 = >成功
0 = > 余额不足
1 = > 没有此用户
msg 成功or其他信息 String N 如：”用户未登录”…
data 返回的data内容 Object/Array Y 不需要返回数据的时候可为空

data如果有多个对象，用数组表示，如下面的

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    "users": [
        {
            "id": "777",
            "name": "Vicky"
        },
        {
            "id": "888",
            "name": "Rod"
        }
        ...
    ]
}