接口文档定义

1.品牌列表分页+条件实现查询

根据用户输入的品牌名称或首字母查询品牌信息,并对查询结果做分页处理。

请求地址:

GET   192.168.30.37:9011/brand/searchPage/1/2?letter=C

请求参数说明

参数 类型 必填 说明
letter/name String 用户输入的品牌名称品牌首字母
page int 从当前页码开始展示
size int 每页展示的数据条数

结果参数说明

参数 类型 说明
flag boolean 是否成功
code Integer 返回码
message String 返回信息
data object 返回数据

返回结果示例

image

2.根据商品分类查询品牌列表

请求地址

GET  192.168.30.37:9001/brand/category/{category}

请求参数说明

参数 类型 必填 说明
category String 商品分类名称

结果参数说明

参数 类型 说明
flag boolean 是否成功
code Integer 返回码
message String 返回信息
data object 返回数据

返回结果示例

image

3.FastDFS文件上传

请求地址

POST  192.168.30.37:9008/file/upload

请求参数说明

参数 类型 必填 说明
file MultipartFile 文件

结果参数说明

参数 类型 说明
flag boolean 是否成功
code Integer 返回码
message String 返回信息
data object 返回数据

返回结果示例

{
    "flag": true,
    "code": 20000,
    "message": "文件上传成功",
    "data": "http://192.168.200.128:8080/group1/M00/00/00/wKjIgF8S7QKAKLwhAAFfJjSCAf4523.png"
}

4.管理员登录实现

请求地址

POST   192.168.30.37:9101/system/admin/login

请求参数说明

参数 类型 必填 说明
login_name String 用户名
password String 密码
status String 状态

请求参数展示

{
    "login_name":"admin",
    "password":"123456",
    "status":"1"
}

结果参数说明

参数 类型 说明
flag boolean 是否成功
code Integer 返回码
message String 返回信息
data object 返回数据

返回结果展示

{
    "flag": true,
    "code": 20000,
    "message": "登陆成功",
    "data": {
        "login_name": "admin",
        "token": "eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiJjOWVmNjM1ZS04NDUzLTRkMWItOWQ5OS00OTQ1ODU1ZmZhMzgiLCJzdWIiOiJhZG1pbiIsImlzcyI6ImFkbWluIiwiaWF0IjoxNTk1MDc2Mjg3LCJleHAiOjE1OTUwNzk4ODd9.rjbcg5I1gHZBdQbzMWhTDHG0xk9-tgoAjugOX4okf98"
    }
}

5.spu和sku添加

  1. SPU 是商品信息聚合的最小单位,是一组可复用、易检索的标准化信息的集 合,该集合描述了一个产品的特性。例如:华为P30 就是一个 SPU。
  2. SKU 即库存进出计量的单位, 可以是以件、盒、托盘等为单位。例如:华为P30 红色 64G 就是一个 SKU。

请求地址

POST 192.168.30.37:9101/goods/spu/add

请求参数说明

参数 类型 必填 说明
goods Goods 由spu和skuList封装成的一个对象

请求参数示例

{
    "spu": {
        "name": "这个是商品名称",
        "caption": "这个是副标题",
        "brandId": 8557,
        "category1Id": 558,
        "category2Id": 559,
        "category3Id": 560,
        "freightId": 10,
        "image": "http://www.changgou.com/image/1.jpg",
        "images": "http://www.changgou.com/image/1.jpg,http://www.changgou.com/image/2.jpg",
        "introduction": "这个是商品详情,html代码",
        "paraItems": "{'出厂年份 ': '2019 ','赠品 ': '充电器 '}",
        "saleService": "七天包退,闪电退货",
        "sn": "020102331",
        "specItems": "{'颜色 ': ['红 ', '绿 '],'机身内存 ': ['64 G', '8 G'],'templateId': 42}"
    },
    "skuList": [{
            "sn": "10192010292",
            "num": 100,
            "alertNum": 20,
            "price": 900000,
            "spec": "{'颜色 ': '红 ','机身内存 ': '64 G '}",
            "image": "http://www.changgou.com/image/1.jpg",
            "images": "http://www.changgou.com/image/1.jpg,http://www.changgou.com/image/2.jpg",
            "status": "1",
            "weight": 130
        },
        {
            "sn": "10192010293",
            "num": 100,
            "alertNum": 20,
            "price": 600000,
            "spec": "{'颜色 ': '蓝 ','机身内存': '128 G '}",
            "image": "http://www.changgou.com/image/1.jpg",
            "images": "http://www.changgou.com/image/1.jpg,http://www.changgou.com/image/2.jpg",
            "status": "1",
            "weight": 130
        }
    ]
}

结果参数说明

参数 类型 说明
flag boolean 是否成功
code Integer 返回码
message String 返回信息
data object 返回数据

返回结果展示

{
    "flag": true,
    "code": 20000,
    "message": "添加成功",
    "data": {
        "null"
    }
}

6.商品修改保存

请求地址

PUT  192.168.30.37:9101/goods/spu/update

请求参数说明

参数 类型 必填 说明
goods Goods 由spu和skuList封装成的一个对象

请求参数示例

{
    "spu": {
        "id":"1285128829483876352",
        "name": "这个是商品名称2",
        "caption": "这个是副标题2",
        "brandId": 8557,
        "category1Id": 558,
        "category2Id": 559,
        "category3Id": 560,
        "freightId": 10,
        "image": "http://www.changgou.com/image/1.jpg",
        "images": "http://www.changgou.com/image/1.jpg,http://www.changgou.com/image/2.jpg",
        "introduction": "这个是商品详情,html代码",
        "paraItems": "{'出厂年份 ': '2019 ','赠品 ': '充电器 '}",
        "saleService": "七天包退,闪电退货",
        "sn": "020102331",
        "specItems": "{'颜色 ': ['红 ', '绿 '],'机身内存 ': ['64 G', '8 G'],'templateId': 42}"
    },
    "skuList": [{
            "sn": "10192010292",
            "num": 100,
            "alertNum": 20,
            "price": 9900000,
            "spec": "{'颜色 ': '红 ','机身内存 ': '64 G '}",
            "image": "http://www.changgou.com/image/1.jpg",
            "images": "http://www.changgou.com/image/1.jpg,http://www.changgou.com/image/2.jpg",
            "status": "1",
            "weight": 130
        },
        {
            "sn": "10192010293",
            "num": 100,
            "alertNum": 20,
            "price": 6600000,
            "spec": "{'颜色 ': '蓝 ','机身内存': '128 G '}",
            "image": "http://www.changgou.com/image/1.jpg",
            "images": "http://www.changgou.com/image/1.jpg,http://www.changgou.com/image/2.jpg",
            "status": "1",
            "weight": 130
        }
    ]
}

结果参数说明

参数 类型 说明
flag boolean 是否成功
code Integer 返回码
message String 返回信息
data object 返回数据

返回结果展示

{
    "flag": true,
    "code": 20000,
    "message": "修改成功",
    "data": null
}

你可能感兴趣的:(接口文档定义)