系统登录接口文档Demo

接口描述

该接口用于用户登录验证。通过用户名和密码进行身份验证，成功后返回一个用于后续请求的认证 token。这个 token 是访问受保护资源的凭证。

时序图：

登录请求：

登录查询接口:

POST {url}/api/user/login

请求体:

{"username": "exampleUser","password": "examplePassword"
}

请求参数列表

参数名	类型	意义	是否必传	备注
username	string	用户名	必传 (M)	无
password	string	密码	必传 (M)	密码为服务器SM2公钥加密后值

响应示例

成功响应

1. 状态码: 200 OK
2. 类型: LoginResp

3. {"code": 0,"message": "Success","data":{"token": "123456789abcdef"
   }
   }
   

用户名不存在错误响应

1. 状态码: 401 Unauthorized
2. 类型: ErrorResponse

{"code": 401,"message": "Unauthorized username","data": 
}

密码错误错误响应

1. 状态码: 401 Unauthorized
2. 类型: ErrorResponse

{"code": 401,"message": "Unauthorized","data": "密码错误"
}

公钥与私钥不匹配错误响应

1. 状态码: 401 Unauthorized
2. 类型: ErrorResponse

{"code": 401,"message": "Invalid Credentials","data": "公钥与私钥不匹配"
}

Token生成错误响应

1. 状态码: 500 Internal Server Error
2. 类型: ErrorResponse

{"code": 500,"message": "Token Generation Failed","data": "服务器生成token失败，请重试"
}

服务器内部错误响应

1. 状态码: 500 Internal Server Error
2. 类型: ErrorResponse

{"code": 500,"message": "Internal Server Error","data": "服务器内部错误"
}

 状态码与响应消息

状态码	响应消息	描述
0	Success	请求成功，登录成功并返回token
401	Unauthorized	用户名不存在
401	Unauthorized	密码错误
401	Invalid Credentials	公钥与私钥不匹配
500	Token Generation Failed	服务器生成token失败，请重试
500	Internal Server Error	服务器内部错误

使用场景

1. 登录功能: 用户通过提供用户名和密码登录系统。
2. 身份验证: 登录成功后返回的 token 用于后续请求的身份验证。