商品模块接口文档

一、商品添加

1、基本信息：

请求路径：/product
请求方式：POST
接口描述：该接口用于商家添加商品于仓库中

2、请求参数：
请求参数格式：applocation/json

参数名称 说明 类型 是否必须 备注
product_name 商品名称 String 是
description 商品描述 String 是
product_pic 商品图片 String 是
price 单价 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,
    "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,
            "consumer_id": 0,
            "description": "华南理工大学出版社",
            "product_pic": "https://img.ixintu.com/download/jpg/20200910/f9256155491e54bf5e99bf29eece0156_512_512.jpg!ys",
            "price": 9.99,
            "category": "学习用品",
            "state": "待售中",
            "create_time": "2024-11-17 08:54:43",
            "update_time": "2024-11-17 08:54:43"
        },
        {
            "id": 2,
            "product_name": "信息安全概论",
            "store_id": 1,
            "consumer_id": 0,
            "description": "华南理工大学出版社",
            "product_pic": "https://img.ixintu.com/download/jpg/20200910/f9256155491e54bf5e99bf29eece0156_512_512.jpg!ys",
            "price": 9.99,
            "category": "学习用品",
            "state": "待售中",
            "create_time": "2024-11-17 08:54:51",
            "update_time": "2024-11-17 08:54:51"
        }
    ]
}

三、商品查询

1、基本信息：

请求路径：/product/detail
请求方式：GET
接口描述：该接口用于通过id值查询商品详细信息

2、请求参数：
请求参数格式：params

参数名称 说明 类型 是否必须 备注
id ID主键 number 是

3、请求样例：

~/product/detail?id=2

4、响应数据：
响应类型：applicaytion/json
响应参数说明：

参数名称 类型 是否必须 默认值 备注 其他信息
code number 是 响应码，0-成功，1-失败
message String 否 提示信息
data String 否 返回的数据

响应数据样例：

{
    "code": 0,
    "massage": "操作成功",
    "data": {
        "id": 2,
        "product_name": "信息安全概论",
        "store_id": 1,
        "consumer_id": 0,
        "description": "华南理工大学出版社",
        "product_pic": "https://img.ixintu.com/download/jpg/20200910/f9256155491e54bf5e99bf29eece0156_512_512.jpg!ys",
        "price": 9.99,
        "category": "学习用品",
        "state": "待售中",
        "create_time": "2024-11-17 08:54:51",
        "update_time": "2024-11-17 08:54:51"
    }
}

四、商品更新

1、基本信息：

请求路径：/product
请求方式：PUT
接口描述：该接口用于商家更新商品信息

2、请求参数：
请求参数格式：applocation/json

参数名称 说明 类型 是否必须 备注
id 主键ID number 是
product_name 商品名称 String 是
description 商品描述 String 是
product_pic 商品图片 String 是
price 单价 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,
    "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、请求参数：
请求参数格式：params

参数名称 说明 类型 是否必须 备注
id 主键ID number 是

3、请求样例：

~/product?id=2

4、响应数据：
响应类型：applicaytion/json
响应参数说明：

参数名称 类型 是否必须 默认值 备注 其他信息
code number 是 响应码，0-成功，1-失败
message String 否 提示信息
data String 否 返回的数据

响应数据样例：

{
    "code": 0,
    "massage": "操作成功",
    "data": "当前时间： 02:17:58.896645100 来自于 MiniShopping "
}

六、商品状态更新

1、基本信息：

请求路径：/product/updateState
请求方式：PATCH
接口描述：该接口用于更新商品状态

2、请求参数：
请求参数格式：Params

参数名称 说明 类型 是否必须 备注
id 主键ID number 是
state 新状态 String 是 待售中，审核中，出售中，已出售

3、请求样例：

~/product/updateState?id=1&state=出售中

4、响应数据：
响应类型：applicaytion/json
响应参数说明：

参数名称 类型 是否必须 默认值 备注 其他信息
code number 是 响应码，0-成功，1-失败
message String 否 提示信息
data String 否 返回的数据

响应数据样例：

{
    "code": 0,
    "massage": "操作成功",
    "data": "当前时间： 02:17:58.896645100 来自于 MiniShopping "
}

六、商品搜索

1、基本信息：

请求路径：/product/search
请求方式：GET
接口描述：该接口用于在搜索条件下获取商品，支持混合参数，支持分页查询。

2、请求参数：
请求参数格式：Params

参数名称 说明 类型 是否必须 备注
pageNum 页面最大数 number 是
pageSize 页面数 number 是
name 商品名称 String 否 可以不传也可以传空值，支持模糊搜索
store_id 商家ID number 否 可以传空值
consumer_id 卖家ID number 否 可以传空值;;;0代表默认值，即没有买家
description 买家描述 number 否 可以不传也可以传空值；支持模糊搜索
min_price 最低价 number 否 可以不传也可以传空值，只能整数
max_price 最高价 number 否 可以不传也可以传空值，只能整数
category 商品类别 String 否 可以不传也可以传空值，；；；；学习用品，电子产品，服装服饰，生活用品，体育器材，食品饮料，健康药品，艺术用品，书籍杂志或其他
state 商品状态 String 否 可以不传也可以传空值；；；待售，出售中，已出售

备注：如果除了必要参数pageNum和pageSize，没有任何参数，将默认导出所有商品，包括待售、销售中等所有商品状态。

3、请求样例：

~/product/search?name=论&pageNum=1&pageSize=12&description=出版社&category=学习用品&state=出售中&min_price=&max_price=10&store_id=1

4、响应数据：
响应类型：applicaytion/json
响应参数说明：

参数名称 类型 是否必须 默认值 备注 其他信息
code number 是 响应码，0-成功，1-失败
message String 否 提示信息
data String 否 返回的数据

响应数据样例：

{
    "code": 0,
    "massage": "操作成功",
    "data": {
        "total": 2,
        "list": [
            {
                "id": 1,
                "product_name": "信息安全概论",
                "store_id": 1,
                "consumer_id": 0,
                "description": "华南理工大学出版社",
                "product_pic": "https://img.ixintu.com/download/jpg/20200910/f9256155491e54bf5e99bf29eece0156_512_512.jpg!ys",
                "price": 9.99,
                "category": "学习用品",
                "state": "待售中",
                "create_time": "2024-11-17 08:54:43",
                "update_time": "2024-11-17 08:54:43"
            },
            {
                "id": 2,
                "product_name": "信息安全概论",
                "store_id": 1,
                "consumer_id": 0,
                "description": "华南理工大学出版社",
                "product_pic": "https://img.ixintu.com/download/jpg/20200910/f9256155491e54bf5e99bf29eece0156_512_512.jpg!ys",
                "price": 9.99,
                "category": "学习用品",
                "state": "待售中",
                "create_time": "2024-11-17 08:54:51",
                "update_time": "2024-11-17 09:00:25"
            }
        ]
    }
}

total为查询结果数量（数据库全部查询结果，没有分页情况下的数量），list为查询结果列表(根据页码pageNum和一个分页大小pageSize分配结果)

六、商品交易

1、基本信息：

请求路径：//product/buy
请求方式：PUT
接口描述：该接口用于用户购买商品

2、请求参数：
请求参数格式：Params

参数名称 说明 类型 是否必须 备注
id 商品主键ID number 是

3、请求样例：

~/product/buy?id=2

4、响应数据：
响应类型：applicaytion/json
响应参数说明：

参数名称 类型 是否必须 默认值 备注 其他信息
code number 是 响应码，0-成功，1-失败
message String 否 提示信息
data String 否 返回的数据

响应数据样例：

{
    "code": 0,
    "massage": "操作成功",
    "data": "当前时间： 02:17:58.896645100 来自于 MiniShopping "
}
posted @ 2024-11-16 02:20  许凌铎  阅读(21)  评论(0)  编辑  收藏  举报