API接口规范

在做API接口开发的时候，需要注意在进行API开发的时候的一些规范，下面是一些常见的整理：

一、路由命名规范

动作	前缀	备注
获取	get	get{xxx}
获取	get	get{xxx}
新增	add	add{xxx}
修改	update	update{xxx}
保存	save	save{xxx}
删除	delete	delete{xxx}
上传	upload	upload{xxx}
发送	send	send{xxx}

二、请求方式

请求方式	描述
GET	获取数据
POST	新增数据
PUT	更新数据
DELETE	删除数据

三、请求参数

Query
url?后面的参数，存放请求接口的参数数据。

Header

请求头，存放公共参数、requestId、token、加密字段等。

Body
Body 体，存放请求接口的参数数据。

四、返回参数

参数	类型	说明	备注
code	Number	结果码	成功：1 失败：0 未登录：401 无权限：403
msg	String	信息	提示信息,用于定位问题
data	Object	数据	JSON格式

示例：

{
  "code": 1,
  "msg": "success",
  "data": {
    "list": [],
    "total": 10,
    "currentPage" : 1,
    "limit": 10
  }
}

以上就是关于API接口开发的基本规范。