API Instructions
- (API相关说明)
| part | content |
|---|---|
| 接口前缀 | /api (使用这个-默认使用) |
| 开发环境 | /dev-api (测试环境) |
| 生产环境 | /prod-api(线上环境) |
用户注册(Register)
TIP
用户注册接口(url Interface Address):
/register
请求方法(HTTP method):post
功能描述(Function Description):用户注册
使用(Example)
JS
// params(提交参数)
{
username:'tiangong', //账号必填项-手机号格式
password:'xxxxxx',// 密码必填项
code:'xxxxxx',
uuid:'xxxxxx',
confirmPassword:'xxxxxx', // 确认密码
}
// response(返回参数)
{
"code": 200, // 200:成功
"message": "用户注册成功,欢迎你去登陆!"
}
// 用户已存在
{
"code": 401,
"data": [],
"message": "用户名已经存在!"
}用户登录( Login)
TIP
接口名称(url Interface Address):
/login
请求方法(HTTP method):post
功能描述(Function Description):用户登录
使用(Example)
JS
// params(提交参数)
{
username:'tiangong', //账号必填项-手机号格式
password:'xxxxxx',// 密码必填项
code:'xxxxxx',
uuid:'xxxxxx',
}
// response(返回参数)
{
code:200,
data:{
token:'xxxxxx',
}
}Logout(用户退出登录)
| part | content |
|---|---|
| url | /logout |
| method | post |
| Function | user Loginout |
JS
// params(提交参数)
{
code:200,
message:'退出成功'
}TokenInfo(登录人信息接口)
| part | content |
|---|---|
| url | /getInfo |
| method | get |
| Function | 使用token换取登录人信息 |
JS
//请求参数
params(请求头)
headers: {
'Authorization': 'Bearer '+'xxx(token)',
},
//返回参数
{
code: 200,
data: {}, // 返回用户信息
message: '欢迎你的访问!',
}Setting(系统设置)
JS
url: /setting
method: get
Function: 获取系统设置getRoutes(动态路由接口)
JS
url: /getRoutes
method: get
Function: 获取动态路由
//请求参数
params(请求头)
headers: {
'Authorization': 'Bearer '+'xxx(token)',
},
//返回参数 树形结构
{
code: 200,
data: {}, // 返回用户信息
message: '欢迎你的访问!',
}
meta: {
title: '系统管理', // 菜单名称
icon: 'el-icon-setting', // 菜单图标
isLink: true, // 是否是外部链接
isHide: false, // 是否隐藏
isKeepAlive: true, // 是否缓存
isAffix: false, // 是否固定
}