基於asp.net core webapi的商品管理系統Api開發(二)登錄功能Api


基礎知識

一 同一狀態碼200響應格式

http狀態碼無條件統一為200,表示服務器處理請求了

http狀態碼為其他比如201,404,500,都是非正常的處理

響應數據=code+msg+data

[code]=(-1=失敗|1=成功|2=其他成功)

[msg]=[當code=-1時輸出錯誤信息]

[data]=[(當code=1是才會返回。可以是對象,數組,字符串,數字)]

客戶端使用時統一處理非200的狀態錯誤,200狀態的根據code做業務處理。

 二 Restful風格使用http狀態碼做響應

查詢時=(狀態碼200=成功|400=請求參數有問題|404=沒有找到對象)+(200直接返回數據對象或數組|400返回字符串錯誤信息|404返回空)

插入時=(狀態碼201=成功|400=請求參數有問題)+(201直接返回數據對象|400返回字符串錯誤信息)

修改時=(狀態碼204=成功|400=請求參數有問題)+(204直接返回空修改成功|400驗證返回字符串錯誤信息|404返回空)

刪除時=(狀態碼200=成功|404=未找到)+(200直接返回被修改對象|400驗證返回字符串錯誤信息|404返回空)

客戶端使用時不能統一處理非200的狀態錯誤,要具體根據狀態,確定內容數據

功能分析

 用例=登錄

Usecase=Login

[輸入流]=[登錄表單]=[用戶名+密碼]

[Input]=[LoginInput]=[UseName+Password]

[輸出流]=[登錄結果對象]=[是否正確+token值]

[Output]=[LoginOuput]=[IsOk+Token]+(IsOk=true時Token才有值表示成功,IsOk=false時表示登錄失敗)

接口定義

請求路徑:/Login

請求方法:Post

請求參數:

  用戶名:UseName:不能為空

  密碼:Password:不能為空

響應參數:

  用戶Id:Id:整形

  用戶名:UserName:字符串

  手機號:Mobile:手機號格式

  用戶角色Id:RoleId:整形

  Token

 

代碼

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM