商品模組介面文件

许凌铎發表於2024-11-16

一、商品新增

1、基本資訊：

請求路徑：/product
請求方式：POST
介面描述：該介面用於商家新增商品於倉庫中

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

引數名稱 說明 型別 是否必須 備註
product_name 商品名稱 String 是
description 商品描述 String 是
product_pic 商品圖片 String 是
price 單價 number 是
amount 新增數量 number 是
category 商品類別 String 是 學習用品，電子產品，服裝服飾，生活用品，體育器材，食品飲料，健康藥品，藝術用品，書籍雜誌或（自定義）

3、請求樣例：

{
    "product_name":"軟體工程導論",
    "description":"高等教育出版社 第5版",
    "product_pic":"https://img.ixintu.com/download/jpg/20200910/f9256155491e54bf5e99bf29eece0156_512_512.jpg!ys",
    "price":9.99,
    "amount":1,
    "category":"學習用品"
}

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

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

響應資料樣例：

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

二、倉庫查詢

1、基本資訊：

請求路徑：/product
請求方式：GET
介面描述：該介面用於商家查詢當前倉庫儲存

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

3、請求樣例：
(無引數)

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

引數名稱 型別 是否必須 預設值 備註 其他資訊
code number 是 響應碼，0-成功，1-失敗
message String 否 提示資訊
data String 否 返回的資料，一個列表集合，存放該商家所有商品詳細資訊

響應資料樣例：

{
    "code": 0,
    "massage": "操作成功",
    "data": [
        {
            "id": 1,
            "product_name": "軟體工程導論",
            "store_id": 1,
            "description": "高等教育出版社 第5版",
            "product_pic": "https://img.ixintu.com/download/jpg/20200910/f9256155491e54bf5e99bf29eece0156_512_512.jpg!ys",
            "price": 9.99,
            "amount": 1,
            "category": "學習用品",
            "state": "待售",
            "create_time": "2024-11-16 01:37:42",
            "update_time": "2024-11-16 01:37:42"
        },
        {
            "id": 2,
            "product_name": "資訊保安概論",
            "store_id": 1,
            "description": "華南理工大學出版社",
            "product_pic": "https://img.ixintu.com/download/jpg/20200910/f9256155491e54bf5e99bf29eece0156_512_512.jpg!ys",
            "price": 9.99,
            "amount": 2,
            "category": "學習用品",
            "state": "待售",
            "create_time": "2024-11-16 01:57:06",
            "update_time": "2024-11-16 01:57:06"
        }
    ]
}

三、商品查詢

1、基本資訊：

請求路徑：/product/details
請求方式：GET
介面描述：該介面用於透過id值查詢商品詳細資訊

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

引數名稱 說明 型別 是否必須 備註
id ID主鍵 number 是

3、請求樣例：

~/product/detail?id=1

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

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

響應資料樣例：

{
    "code": 0,
    "massage": "操作成功",
    "data": {
        "id": 1,
        "product_name": "軟體工程導論",
        "store_id": 1,
        "description": "高等教育出版社 第5版",
        "product_pic": "https://img.ixintu.com/download/jpg/20200910/f9256155491e54bf5e99bf29eece0156_512_512.jpg!ys",
        "price": 9.99,
        "amount": 1,
        "category": "學習用品",
        "state": "待售",
        "create_time": "2024-11-16 01:37:42",
        "update_time": "2024-11-16 01:37:42"
    }
}

四、商品更新

1、基本資訊：

請求路徑：/product
請求方式：PUT
介面描述：該介面用於商家更新商品資訊

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

引數名稱 說明 型別 是否必須 備註
id 主鍵ID String 是
product_name 商品名稱 String 是
description 商品描述 String 是
product_pic 商品圖片 String 是
price 單價 number 是
amount 商品數量 number 是
category 商品類別 String 是 學習用品，電子產品，服裝服飾，生活用品，體育器材，食品飲料，健康藥品，藝術用品，書籍雜誌或（自定義）

3、請求樣例：

{
    "id": 2,
    "product_name": "資訊保安概論",
    "description": "華南理工大學出版社",
    "product_pic": "https://img.ixintu.com/download/jpg/20200910/f9256155491e54bf5e99bf29eece0156_512_512.jpg!ys",
    "price": 9.99,
    "amount": 2,
    "category": "學習用品"
}

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

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

響應資料樣例：

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

五、商品刪除

1、基本資訊：

請求路徑：/product
請求方式：DELETE
介面描述：該介面用於透過主鍵ID刪除商品

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

引數名稱 說明 型別 是否必須 備註
id 主鍵ID String 是

3、請求樣例：

~/product?id=2

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

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

響應資料樣例：

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

相關文章