前端如何和后端进行接口约定？

一、如何进行接口约定？

• 一般是根据需求来确定约定的范围
• 接口约定的基本格式
• 示例

1. 如何确定接口约定的范围？

• 首先得到产品的主要功能列表
• 其中涉及数据传输的基本都要约定接口

2. 接口约定的基本格式

约定接口一般包括以下数据

1. 当前接口的路径是什么？ 如 /auth/register

2. 当前接口提交数据的类型是什么? 如

   • GET 获取数据
   • POST 提交或者创建
   • PATCH 修改数据，部分修改
   • DELETE 删除数据
   • PUT 修改数据，整体替换原有数据

3. 参数类型/格式，比如是 json 格式，还是 application/x-www-form-urlencoded的数据

4. 参数字段，及限制条件

5. 返回成功的数据格式

6. 返回失败的数据格式

3. 数据示例

认证相关

POST /auth/register

功能: 用户注册

提交参数

• 参数类型:Content-Type: application/x-www-form-urlencoded;charset=utf-8

• 参数字段

  • username : 用户名, 长度1到15个字符，只能是字母数字下划线中文
  • password : 密码, 长度6到16个任意字符

返回数据

• 失败

  • 状态码 400
  • 返回格式 {msg: '错误原因'}

• 成功

  • 状态码 200
  • 返回格式

{
  "msg": "注册成功",
  "data": {
    "id": 1,
    "username": "hunger",
    "updatedAt": "2017-12-27T07:40:09.697Z",
    "createdAt": "2017-12-27T07:40:09.697Z"
  }
}

GET /auth

功能: 判断用户是否登录

提交参数: 无

返回数据

• 已经登录的情况

{
  "isLogin": true,
  "data": {
    "id": 1,
    "username": "hunger",
    "updatedAt": "2017-12-27T07:40:09.697Z",
    "createdAt": "2017-12-27T07:40:09.697Z"
  }
}

• 没有登录的情况

{
  "isLogin": false
}