1.api版本

v1为版本号

/api/v1

2.常见的参数

• ?limit=100：返回100条数据
• ?offset=101：从第101条数据开始返回
• ?page=10：指第10页
• per_page=100：每页100条数据
• ?sortby=name：排序字段
• ?order=desc：降序
• ?group=groupName:分组
• ?producy_type=1：筛选条件

3.返回数据格式

返回数据格式，一般包括三个字段：

{
 
“status”:0,//状态码 0-表示失败，1-表示成功
 
“error_code”:”2003”,//错误码，一般在设计时定义
 
“error_des”:”身份验证失败”//错误描述，一般在设计时定义
 
}

4.定义api返回码

在api设计时，要定好api返回码，如

• 1 –授权过期
• 404–未找到资源
• 500–内部服务器错误
• 600–账号被锁

5.定义统一错误码

定义接口授权类别

6.多级url写法

比如汇款动作，从账户1向账户2汇款500元。如何设计URL

POST /accounts/transaction?from=1&to=2&amount=500.00；

7.状态码