# 用戶注冊api接口 ## 接口文檔 ## 1.端點設計 | 接口名稱 |端點 |請求方法 | 說明 | | --- | --- | --- | --- | | 用戶注冊 |http://api.daiban.com/users | post |用戶注冊 | ## 2.參數 | 參數名稱 |是否必填 |類型 | 說明 | | --- | --- | --- | --- | | username|是 | string |用戶名(手機號)| | password|是 | string |密碼| | repassword|是 | string |密碼| | code|是 | string |手機驗證碼| | timestamp|是 | int|時間戳| ## 3.header 如果是APP項目 需要傳遞必要的信息 建議放到header傳遞 | 參數名稱 |是否必填 |類型 | 說明 | | --- | --- | --- | --- | | sign|是 | int|簽名| ## 4.響應 > 接口無論是否請求成功或者失敗，都需要給請求方有響應數據返回。只有這樣才可以給請求方更好的體驗，也方便接口調試。在這里我們統一用JSON格式的數據返回。返回的數據結構需要根據項目的需求來定。 #### 響應數據如下： 響應頭 ``` HTTP/1.1 200 OK Content-Type:application/json ``` 返回數據 ``` { message:"注冊成功", data:{}, errorcode:0 } ``` ## 5.錯誤碼 項目錯誤碼對照表 | 項目錯誤碼 | 說明 | | --- | --- | | 60000|用戶名格式不正確| | 60001|密碼不正確| | 60002|驗證碼錯誤| | 60003|請求超時| | 60004|未知錯誤| | 60005|時間戳不正確| | 60006|參數錯誤| | 60007|簽名錯誤| | 60008|參數獲取失敗| 項目使用HTTP狀態碼 | 項目狀態碼| 說明 | | --- | --- | | 200|服務器成功處理請求| | 201|服務器成功創建資源| | 400|錯誤請求服務器不理解請求的語法| | 401|未授權請求，要求身份驗證| | 403|服務器禁止，拒絕請求| | 404|服務器找不到請求的網頁| | 500|服務器內部錯誤服務器遇到錯誤，無法完成請求| ## 6.開發流程 1.創建Users 控制器controller //繼承Common控制器 提供訪問接口 接受和返回數據 與數據庫表對應 名字一致 2.創建Common 控制器controller //繼承基礎控制器 初始化業務驗證 驗證簽名 定義返回數據json類型 3.創建User 驗證類文件 //繼承BaseValidate類 Validate 驗證字段 4.創建BaseValidate 驗證類文件 //繼承基礎驗證類 獲取客戶端請求數據 5.創建User 模型model //將數據寫入數據庫 名稱不一致 須制定表名