[TOC] ## 路由命名規范 | 動作 | 前綴 | 備注 | | --- | --- | --- | | 獲取 | get | get{XXX} | | 獲取 | get | get{XXX}List | | 新增 | add | add{XXX} | | 修改 | update | update{XXX} | | 保存 | save | save{XXX} | | 刪除 | delete | delete{XXX} | | 上傳 | upload | upload{XXX} | | 發送 | send | send{XXX} | ## 請求方式 | 請求方式 | 描述 | | --- | --- | | GET | 獲取數據 | | POST | 新增數據 | | PUT | 更新數據 | | DELETE | 刪除數據 | ## 請求參數 ### APP 端請求,公共參數 | 參數 | 說明 | 備注 | | --- | --- | --- | | network | 網絡 | WIFI、4G | | operator | 運營商 | 中國聯通/移動 | | platform | 平臺 | iOS、Android | | system | 系統 | ios 13.3、android 9 | | device | 設備型號 | iPhone XR、小米9 | | udid | 設備唯一標示 | | | apiVersion | API 版本號 | v1.1、v1.2 | ### WEB 端請求 | 參數 | 說明 | 備注 | | --- | --- | --- | | appKey | 授權Key | 字符串 | ### 請求參數安全規范 #### 敏感參數加密處理 登錄密碼、支付密碼，需加密后傳輸，建議使用 `非對稱加密`。 #### 其他規范 **參數命名規范**?建議使用駝峰命名，首字母小寫。 **requestId**?建議攜帶唯一標示追蹤問題。 ## 返回參數 ### 返回參數格式 | 參數 | 類型 | 說明 | 備注 | | --- | --- | --- | --- | | code | Number | 結果碼 | 成功=1 ; 失敗=-1 ; 未登錄=401 ;無權限=403 | | showMsg | String | 顯示信息 | 系統繁忙，稍后重試 | | errorMsg | String | 錯誤信息 | 便于研發定位問題 | | data | Object | 數據 | JSON 格式 | #### 分頁數據返回格式 ``` { "code": 1, "showMsg": "success", "errorMsg": "", "data": { "list": [], "pagination": { "total": 100, "currentPage": 1, "prePageCount": 10 } } } ``` ### 安全規范 #### 敏感數據脫敏處理 用戶手機號、用戶郵箱、身份證號、支付賬號、郵寄地址等要進行脫敏，部分數據加 `*` 號處理。 ### 其他規范 * 屬性名命名時，建議使用駝峰命名，首字母小寫。 * 屬性值為空時，嚴格按類型返回**默認值**。 * 金額類型/時間日期類型的屬性值，如果僅用來顯示，建議**后端**返回可以顯示的字符串。 * 業務邏輯的狀態碼和對應的文案，建議后端兩者都返回。 * 調用方不需要的屬性，不要返回。