Login 登陆接口 - GlimmerIndex/Glimmer-Index-Back-End GitHub Wiki
请求地址
http://host/user/login
配置SSL后改为https
请求方法
POST
请求头
key | value |
---|---|
Content-Type | application/json |
请求体
User类型对象的账号密码,使用Json格式
属性名 | 描述 |
---|---|
userName | 账户名 |
password | 密码(加密前) |
返回
ResultBody,参见文档(待写) 若成功登陆,data携带token,之后的请求可以使用token进行认证。
示例
数据库中已经创建好user_name
为anti_test
,密码为1234
的用户。尝试登陆
POST /user/login HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Content-Length: 58
{
"userName": "anti_test",
"password": "1234"
}
返回结果:
{
"code": 200,
"msg": "登陆成功",
"data": {
"token": "eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiI2M2Y0ZWFmMDhlNjA0YTk2YTVjZjczMDllNTY0ZjYxOSIsInN1YiI6IjMiLCJpc3MiOiJnbGltbWVyIiwiaWF0IjoxNjc5MTQ3MjU4LCJleHAiOjE2NzkxNTA4NTh9.64Yr2A6Y_raXGwDOQVMY5nVgeCoTilYbBeF7-O6pNhk"
}
}
token之后被用户用作鉴权工具,在服务端被存储在Redis缓存中。默认一周后过期。
接下来是一些登陆失败的实例。
当密码错误时
POST /user/login HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Content-Length: 57
{
"userName": "anti_test",
"password": "123"
}
返回
{
"code": 401,
"msg": "用户认证失败,请重新登陆"
}
当用户不存在时,也会返回这个结果
POST /user/login HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Content-Length: 60
{
"userName": "not_existed",
"password": "1234"
}
返回结果:
{
"code": 401,
"msg": "用户认证失败,请重新登陆"
}
总之,返回401可以认为认证失败。