API Instructions
- (API相关说明)
part | content |
---|---|
接口前缀 | /api (使用这个) |
开发环境 | /dev-api |
生产环境 | /prod-api |
Register(用户注册)
part | content |
---|---|
url Interface Address(接口地址) | /register |
HTTP method(http方法 ) | post |
Function Description (功能描述 ) | 用户注册 |
JS
// params(提交参数)
{
username:'tiangong', //账号必填项-手机号格式
password:'xxxxxx',// 密码必填项
code:'xxxxxx',
uuid:'xxxxxx',
confirmPassword:'xxxxxx', // 确认密码
}
// response(返回参数)
{
"code": 200, // 200:成功
"message": "用户注册成功,欢迎你去登陆!"
}
// 用户已存在
{
"code": 401,
"data": [],
"message": "用户名已经存在!"
}
Login(用户登录)
part | content |
---|---|
url | /login |
method | post |
Function | user Login |
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: '欢迎你的访问!',
}