约定接口6个
约定6个接口:
1.路由
2.类型
3.提交参数的格式
4.字段
5.成功的数据格式
6.失败的数据格式
约定接口一般包括以下数据
-
(路由)当前接口的路径是什么? 如
/auth/register
-
当前接口提交数据的类型是什么? 如
GET
获取数据POST
提交或者创建PATCH
修改数据,部分修改DELETE
删除数据PUT
修改数据,整体替换原有数据
-
参数类型/格式,比如是 json 格式,还是
application/x-www-form-urlencoded
的数据 -
参数字段,及限制条件
-
返回成功的数据格式
-
返回失败的数据格式
认证相关
POST /auth/register
功能: 用户注册
提交参数
- 参数类型:`Content-Type: application/x-www-form-urlencoded;charset=utf-8`
- 参数字段
- `username` : 用户名, 长度1到15个字符,只能是字母数字下划线中文
- `password` : 密码, 长度6到16个任意字符
返回数据
- 失败
- 状态码 400
- 返回格式 `{msg: '错误原因'}`
- 成功
- 状态码 200
- 返回格式
GET /auth
功能: 判断用户是否登录
提交参数: 无
返回数据
GET /auth/logout