商家模組介面文件

许凌铎發表於2024-11-16

一、商家註冊

1、基本資訊：

請求路徑：/store/register
請求方式：POST
介面描述：該介面用於商家透過手機號註冊賬號

2、請求引數：
請求引數格式：application/x-www-form-urlencoded

引數名稱 說明 型別 是否必須 備註
phone 手機號碼 String 是 必須輸入11位
password 登入密碼 String 是 必須5-16位

3、請求樣例：

{
  “phone”: "12345678901"
  “password”： “123456”
}

4、響應資料：
響應型別：applicaytion/json
響應引數說明：

引數名稱 型別 是否必須 預設值 備註 其他資訊
code number 是 響應碼，0-成功，1-失敗
message String 否 提示資訊
data String 否 返回的資料

響應資料樣例：

{
    "code": 1,
    "massage": "該手機號已註冊",
    "data": null
}

{
    "code": 0,
    "massage": "操作成功",
    "data": "當前時間： 19:11:30.229368700 來自於 MiniShopping "
}

二、商家登入

1、基本資訊：

請求路徑：/store/login
請求方式：POST
介面描述：該介面用於商家透過手機號登入賬號

2、請求引數：
請求引數格式：application/x-www-form-urlencoded

引數名稱 說明 型別 是否必須 備註
phone 手機號碼 String 是 必須輸入11位
password 登入密碼 String 是 必須5-16位

3、請求樣例：

{
  “phone”: "12345678901"
  “password”： “123456”
}

4、響應資料：
響應型別：applicaytion/json
響應引數說明：

引數名稱 型別 是否必須 預設值 備註 其他資訊
code number 是 響應碼，0-成功，1-失敗
message String 否 提示資訊
data String 否 返回的資料是JWT令牌，需要客戶端儲存該令牌，後續請求進行附帶作為已登入標誌同時驗證身份 JWT令牌申請後一個小時自動過期

響應資料樣例：

{
    "code": 1,
    "massage": "該手機號未註冊",
    "data": null
}

{
    "code": 1,
    "massage": "密碼錯誤",
    "data": null
}

{
    "code": 0,
    "massage": "操作成功",
    "data": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGFpbXMiOnsicGhvbmUiOiIxMjM0NTY3ODkwNyIsImlkIjo2fSwiZXhwIjoxNzMxNzEyNzIxfQ.suxQYM1Byw8p6WV7xCb-cbvkMcLYKw5EA2kO8gnMzlA"
}

三、獲取商家基本資訊

1、基本資訊：

請求路徑：/store/storeInfo
請求方式：GET
介面描述：該介面用於商家獲取基本資訊

2、請求引數：無，但需要將登入時下發的JWT令牌附帶於請求頭header中，請求頭名稱為Authorization,值為JWT令牌(除了註冊以及登入之外，訪問其它介面都需要這個請求頭)
請求格式：applicaytion/json

3、請求樣例：無

4、響應資料：
響應型別：applicaytion/json
響應引數說明：

引數名稱 型別 是否必須 預設值 備註 其他資訊
code number 是 響應碼，0-成功，1-失敗
message String 否 提示資訊
data Object 是 返回的資料

響應資料樣例：

{
    "code": 0,
    "massage": "操作成功",
    "data": {
        "id": 2,
        "phone": "12345678903",
        "nickname": "",
        "gender": "",
        "user_pic": "",
        "address": "",
        "email": "",
        "create_time": "2024-11-15T01:53:47",
        "update_time": "2024-11-15T01:53:47"
    }
}

四、更新商家資訊

1、基本資訊：

請求路徑：/store/update
請求方式：PUT
介面描述：該介面用於商家更新不重要資訊（除了id，手機號，頭像和密碼）

2、請求引數：
請求引數格式：applocation/json

引數名稱 說明 型別 是否必須 備註
id 主鍵ID number 是 用於驗證身份，在該介面無法修改
phone 手機號 String 是 用於驗證身份，在該介面無法修改
store_name 暱稱 String 否
address 地址 String 否
email 郵箱 String 否 非空時需要滿足電子郵箱格式

3、請求樣例：

{
        "id": 3,
        "store_name": "",
        "store_pic": "",
        "address": "",
        "phone": "12345678901",
        "email": "",
        "money": 0,
        "create_time": "2024-11-16 00:53:42",
        "update_time": "2024-11-16 00:53:42"
    }

4、響應資料：
響應型別：applicaytion/json
響應引數說明：

引數名稱 型別 是否必須 預設值 備註 其他資訊
code number 是 響應碼，0-成功，1-失敗
message String 否 提示資訊
data String 否 返回的資料

響應資料樣例：

{
    "code": 0,
    "massage": "操作成功",
    "data": "當前時間： 01:02:29.904431100 來自於 MiniShopping "
}

五、更新使用者頭像

1、基本資訊：

請求路徑：/user/updateAvatar
請求方式：PATCH
介面描述：該介面用於使用者更新頭像

2、請求引數：
請求引數格式：applocation/json

引數名稱 說明 型別 是否必須 備註
avatarUrl 頭像 String 是 url地址

3、請求樣例：

？avatarUrl=https://gd-hbimg.huaban.com/e31c65d6e91f54ebc43af8cdf5bbbe27ea94d958452b-I06IS4_fw658

4、響應資料：
響應型別：applicaytion/json
響應引數說明：

引數名稱 型別 是否必須 預設值 備註 其他資訊
code number 是 響應碼，0-成功，1-失敗
message String 否 提示資訊
data String 否 返回的資料

響應資料樣例：

{
    "code": 0,
    "massage": "操作成功",
    "data": "當前時間： 01:02:29.904431100 來自於 MiniShopping "
}

六、更新使用者密碼

1、基本資訊：

請求路徑：/user/updatePwd
請求方式：PATCH
介面描述：該介面用於使用者更新密碼

2、請求引數：
請求引數格式：applocation/json

引數名稱 說明 型別 是否必須 備註
old_pwd 原密碼 String 是 必須5-16位
new_pwd 新密碼 String 是 必須5-16位
re_pwd 再次輸入的密碼 String 是 必須5-16位

3、請求樣例：

{
    "old_pwd":"654321",
    "new_pwd":"123456",
    "re_pwd":"123456"
}

4、響應資料：
響應型別：applicaytion/json
響應引數說明：

引數名稱 型別 是否必須 預設值 備註 其他資訊
code number 是 響應碼，0-成功，1-失敗
message String 否 提示資訊
data String 否 返回的資料

響應資料樣例：

{
    "code": 0,
    "massage": "操作成功",
    "data": "當前時間： 01:04:53.710773800 來自於 MiniShopping "
}

相關文章