免費(fèi)建站網(wǎng)站一級(jí)大陸在線看網(wǎng)站優(yōu)化推廣培訓(xùn)
接口描述
該接口用于用戶登錄驗(yàn)證。通過用戶名和密碼進(jìn)行身份驗(yàn)證，成功后返回一個(gè)用于后續(xù)請(qǐng)求的認(rèn)證 token。這個(gè) token 是訪問受保護(hù)資源的憑證。
時(shí)序圖：
登錄請(qǐng)求：
登錄查詢接口:
POST {url}/api/user/login請(qǐng)求體:
{"username": "exampleUser","password": "examplePassword"
}
請(qǐng)求參數(shù)列表
| 參數(shù)名 | 類型 | 意義 | 是否必傳 | 備注 |
| username | string | 用戶名 | 必傳 (M) | 無 |
| password | string | 密碼 | 必傳 (M) | 密碼為服務(wù)器SM2公鑰加密后值 |
響應(yīng)示例
成功響應(yīng)
- 狀態(tài)碼: 200 OK
- 類型: LoginResp
-
{"code": 0,"message": "Success","data":{"token": "123456789abcdef" } }
用戶名不存在錯(cuò)誤響應(yīng)
- 狀態(tài)碼: 401 Unauthorized
- 類型: ErrorResponse
{"code": 401,"message": "Unauthorized username","data":
}
密碼錯(cuò)誤錯(cuò)誤響應(yīng)
- 狀態(tài)碼: 401 Unauthorized
- 類型: ErrorResponse
{"code": 401,"message": "Unauthorized","data": "密碼錯(cuò)誤"
}
公鑰與私鑰不匹配錯(cuò)誤響應(yīng)
- 狀態(tài)碼: 401 Unauthorized
- 類型: ErrorResponse
{"code": 401,"message": "Invalid Credentials","data": "公鑰與私鑰不匹配"
}
Token生成錯(cuò)誤響應(yīng)
- 狀態(tài)碼: 500 Internal Server Error
- 類型: ErrorResponse
{"code": 500,"message": "Token Generation Failed","data": "服務(wù)器生成token失敗，請(qǐng)重試"
}
服務(wù)器內(nèi)部錯(cuò)誤響應(yīng)
- 狀態(tài)碼: 500 Internal Server Error
- 類型: ErrorResponse
{"code": 500,"message": "Internal Server Error","data": "服務(wù)器內(nèi)部錯(cuò)誤"
}
?狀態(tài)碼與響應(yīng)消息
| 狀態(tài)碼 | 響應(yīng)消息 | 描述 |
| 0 | Success | 請(qǐng)求成功，登錄成功并返回token |
| 401 | Unauthorized | 用戶名不存在 |
| 401 | Unauthorized | 密碼錯(cuò)誤 |
| 401 | Invalid Credentials | 公鑰與私鑰不匹配 |
| 500 | Token Generation Failed | 服務(wù)器生成token失敗，請(qǐng)重試 |
| 500 | Internal Server Error | 服務(wù)器內(nèi)部錯(cuò)誤 |
使用場(chǎng)景
- 登錄功能: 用戶通過提供用戶名和密碼登錄系統(tǒng)。
- 身份驗(yàn)證: 登錄成功后返回的 token 用于后續(xù)請(qǐng)求的身份驗(yàn)證。