Skip to content

Latest commit

 

History

History
650 lines (542 loc) · 16.2 KB

智慧购物接口11.1.md

File metadata and controls

650 lines (542 loc) · 16.2 KB

智慧购物系统接口文档

一、管理系统接口

服务器

一、密码修改模块

1.登录

  • 接口名: WebMainServlet
  • 功能说明: (用户名:admin,密码:123456)
  • 注意:
字段名 说明 参数类型 备注
method login string 传String类型
username 用户名 String 传String类型
password 密码 String 传String类型
  • 响应示例: -- 返回结果 code :0 其中code代表返回结果,0代表成功。1表示不成功。post请求 ​ 返回结果示例
{
	"count": 0, 
	"code":0,
	"msg":"",
	"data":""
} 

2.修改管理员密码

  • 接口名:WebMainServlet
  • 功能说明:
  • 注意:
字段名 说明 参数类型 备注
method modifyPassword string 传String类型
userName 用户名 String 传String类型
originPsd 原始密码 String 传String类型
newPsd 新密码 String 传String类型
  • 响应示例: -- 返回结果 code :0 其中code代表返回结果,0代表成功。1表示不成功。post请求 ​ 返回结果示例
{
	"count": 0, 
	"code":0,
	"msg":"",
	"data":""
} 

二、商品部分

1.获取商品列表

  • 接口名:WebMainServlet
  • 功能说明:查询goods表,按id倒叙
字段名 说明 参数类型 备注
method getGoodsList string 传String类型
page 当前页码 string 传String类型
limit 每页条数 string 传String类型
  • 响应示例: -- 返回结果 code :0 其中code代表返回结果,0代表成功。1表示不成功。post请求

返回结果示例

{
	"count": 0, 
	"code":0,
	"msg":"",
	"data":[{
         "goodsId":"商品编号",
 		 "goodsName":"商品名称",
 		 "brand": "品牌",
 		 "pack_price": "每盒价格",
 		 "carton_price": "整条价格",
 		 "productionArea": "产地",
 		 "type":"类别",
 		 "tar": "焦油含量",
 		 "newArrival": "是否为新品",
 		 "mainImg": "主图",
 		 "detailImg1": "详情图1",
 		 "detailImg2": "详情图2 ",
 		 "detailImg3": "详情图3",
 		 "detailImg4": "详情图4",
 		 "detailImg5": "详情图5",
 		 "model": "模型(短视频)"
	}]
}

2.新增商品

  • 接口名: WebUploadServlet
  • 功能说明:
字段名 说明 参数类型 备注
method addGoods string 传String类型
goodsName 商品名称 string 传String类型
brand 品牌 string 传String类型
pack_price 每盒价格 float 传float类型
carton_price 整条价格 float 传float类型
productionArea 产地 string 传String类型
type 类别 string 传String类型
tar 焦油含量 string 传String类型
newArrival 是否为新品 string 传String类型
mainImg 主图 file 传file类型
detailImg1 详情图1 file 传file类型
detailImg2 详情图2 file 传file类型
detailImg3 详情图3 file 传file类型
detailImg4 详情图4 file 传file类型
detailImg5 详情图5 file 传file类型
model 模型(短视频) file 传file类型
  • 响应示例:

-- 返回结果 code :0 其中code代表返回结果,0代表成功。1表示不成功。post请求 ​ 返回结果示例

{
	"count": 0, 
	"code":0,
	"msg":"",
	"data":""
}

3.修改商品

  • 接口名:WebUploadServlet
  • 功能说明:
字段名 说明 参数类型 备注
method modifyGoods string 传String类型
goodsId 商品id int 传int类型
goodsName 商品名称 string 传String类型
brand 品牌 string 传String类型
pack_price 每盒价格 float 传float类型
carton_price 整条价格 float 传float类型
productionArea 产地 string 传String类型
type 类别 string 传String类型
tar 焦油含量 string 传String类型
newArrival 是否为新品 string 传String类型
mainImg 主图 file 传file类型
detailImg1 详情图1 file 传file类型
detailImg2 详情图2 file 传file类型
detailImg3 详情图3 file 传file类型
detailImg4 详情图4 file 传file类型
detailImg5 详情图5 file 传file类型
model 模型(短视频) file 传file类型
  • 响应示例:

-- 返回结果 code :0 其中code代表返回结果,0代表成功。1表示不成功。post请求 ​ 返回结果示例

{
	"count": 0, 
	"code":0,
	"msg":"",
	"data":""
}

4.模糊搜索商品名称

  • 接口名: WebMainServlet
  • 功能说明:按关键字对商品名称进行搜索(keyword=goods.goodsName)
字段名 说明 参数类型 备注
method getGoodsByName string 传String类型
keyword 关键字 String 传String类型
  • 响应示例: -- 返回结果 code :0 其中code代表返回结果,0代表成功。1表示不成功。post请求 ​ 返回结果示例
{
	"count": 0, 
	"code":0,
	"msg":"",
	"data":[{
        "id":"编号",
        "goodsId":"商品id",
 		 "goodsName":"商品名称",
 		 "brand": "品牌",
 		 "pack_price": "每盒价格",
 		 "carton_price": "整条价格",
 		 "productionArea": "产地",
 		 "type":"类别",
 		 "tar": "焦油含量",
 		 "newArrival": "是否为新品",
 		 "mainImg": "主图",
 		 "detailImg1": "详情图1",
 		 "detailImg2": "详情图2 ",
 		 "detailImg3": "详情图3",
 		 "detailImg4": "详情图4",
 		 "detailImg5": "详情图5",
 		 "model": "模型(短视频)"
	}]
}

5.删除商品

  • 接口名: WebMainServlet
  • 功能说明:按照编号删除goods表对应商品
字段名 说明 参数类型 备注
method deleteGoods string 传String类型
goodsId 商品编号 int 传String类型
  • 响应示例:

-- 返回结果 code :0 其中code代表返回结果,0代表成功。1表示不成功。post请求 ​ 返回结果示例

{
	"count": 0, 
	"code":0,
	"msg":"",
	"data":""
}

三、订单模块

1.获取订单列表

  • 接口名: WebMainServlet
  • 功能说明:查询orders表,按id倒叙
字段名 说明 参数类型 备注
method getOrders string 传String类型
page 当前页码 string 传String类型
limit 每页条数 string 传String类型
  • 响应示例: -- 返回结果 code :0 其中code代表返回结果,0代表成功。1表示不成功。post请求

返回结果示例

{
	"count": 0, 
	"code":0,
	"msg":"",
	"data":[{
         "id":"编号",
 		 "orderId":"订单编号",
 		 "payTime": "支付时间",
 		 "sum": "总金额",
 		 "payType": "支付方式",
 		 "payer": "支付人"
	}]
}

2.获取订单详情

  • 接口名: WebMainServlet
  • 功能说明:查询ordes表,按id倒叙
字段名 说明 参数类型 备注
method getOrderDetail string 传String类型
orderId 订单id string 传String类型
  • 响应示例: -- 返回结果 code :0 其中code代表返回结果,0代表成功。1表示不成功。post请求

返回结果示例

{
	"count": 0, 
	"code":0,
	"msg":"",
	"data":[{
            "id":"编号",
            "goodsId":"商品名称",
            "unit":"单位(盒pack/条carton)",
            "unitPrice":"下单时的单价",
            "count":"数量",
            "subtotal":"小计"
	}]
}

3.模糊搜索订单

  • 接口名: WebMainServlet

  • 功能说明:按关键字对订单编号进行搜索(keyword=orders.orderId) 字段名 | 说明 | 参数类型 | 备注 ---|---|---|--- method | searchOrders | string | 传String类型 keyword | 关键字 | String | 传String类型

  • 响应示例: -- 返回结果 code :0 其中code代表返回结果,0代表成功。1表示不成功。post请求 ​ 返回结果示例

{
	"count": 0, 
	"code":0,
	"msg":"",
	"data":[{
        "id":"编号",
 		 "orderId":"订单编号",
 		 "payTime": "支付时间",
 		 "sumOfMoney": "总金额",
 		 "payType": "支付方式",
 		 "payer": "支付人"
	}]
}

4.删除订单

  • 接口名: WebMainServlet

  • 功能说明:按照订单编号删除orders表对应订单记录 | 字段名 | 说明 | 参数类型 | 备注 | | ------ | ------------ | -------- | ------------ | | method | deleteOrders | string | 传String类型 | | orderId | 订单编号 | string | 传String类型 |

  • 响应示例:

-- 返回结果 code :0 其中code代表返回结果,0代表成功。1表示不成功。post请求 ​ 返回结果示例

{
	"count": 0, 
	"code":0,
	"msg":"",
	"data":""
}

二、APP端接口

1.得到首页新品

  • 接口名: MainServlet
  • 功能说明:显示goods表中是否为新品结果为true的商品
字段名 说明 参数类型 备注
method getNewArrival string 传String类型
  • 响应示例: -- 返回结果 code :0 其中code代表返回结果,0代表成功。1表示不成功。post请求

    返回结果示例

{
	"count": 0, 
	"code":0,
	"msg":"",
	"data":[{
        "goodsId":"商品id",
        "goodsName":"商品名称",
        "pack_price": "每盒价格",
 		"carton_price": "整条价格",
 	    "mainImg": "主图"
	}]
}

2.根据品牌模糊搜索商品

  • 接口名:MainServlet
  • 功能说明:根据品牌查询goods表中的商品
字段名 说明 参数类型 备注
method getGoodsByBrand string 传String类型
brand 品牌名称 string 传String类型
  • 响应示例: -- 返回结果 code :0 其中code代表返回结果,0代表成功。1表示不成功。post请求

    返回结果示例

{
	"count": 0, 
	"code":0,
	"msg":"",
	"data":[{
        "goodsId":"商品id",
        "goodsName":"商品名称",
        "pack_price": "每盒价格",
 		"carton_price": "整条价格",
 	    "mainImg": "主图"
	}]
}

3.根据类别得到对应商品

  • 接口名:MainServlet
  • 功能说明:根据类别查询goods表中的商品
字段名 说明 参数类型 备注
method getGoodsByType string 传String类型
type 类别(爆珠:bead/细支:fine/中支medium/粗支:wide) string 传bead/fine/medium/wide
  • 响应示例: -- 返回结果 code :0 其中code代表返回结果,0代表成功。1表示不成功。post请求

    返回结果示例

{
	"count": 0, 
	"code":0,
	"msg":"",
	"data":[{
        "goodsId":"商品id",
        "goodsName":"商品名称",
        "pack_price": "每盒价格",
 		"carton_price": "整条价格",
 	    "mainImg": "主图"
	}]
}

4.根据产地模糊搜索商品

  • 接口名:MainServlet
  • 功能说明:根据产地模糊查询goods表中的商品
字段名 说明 参数类型 备注
method getGoodsByArea string 传String类型
area 产地 string 传String类型
  • 响应示例: -- 返回结果 code :0 其中code代表返回结果,0代表成功。1表示不成功。post请求

    返回结果示例

{
	"count": 0, 
	"code":0,
	"msg":"",
	"data":[{
        "goodsId":"商品id",
        "goodsName":"商品名称",
        "pack_price": "每盒价格",
 		"carton_price": "整条价格",
 	    "mainImg": "主图"
	}]
}

5.根据价格区间得到对应商品

  • 接口名:MainServlet
  • 功能说明:根据价格区间查询goods表中的商品
字段名 说明 参数类型 备注
method getGoodsByPrice string 传String类型
priceZone 价格区间(1/2/3/4) string 传1/2/3/4
  • 响应示例: -- 返回结果 code :0 其中code代表返回结果,0代表成功。1表示不成功。post请求

    返回结果示例

{
	"count": 0, 
	"code":0,
	"msg":"",
	"data":[{
        "goodsId":"商品id",
        "goodsName":"商品名称",
        "pack_price": "每盒价格",
 		"carton_price": "整条价格",
 	    "mainImg": "主图"
	}]
}

6.根据焦油含量得到对应商品

  • 接口名:MainServlet
  • 功能说明:根据价格区间查询goods表中的商品
字段名 说明 参数类型 备注
method getGoodsByTar string 传String类型
tar 焦油含量(6毫克以上/6-8毫克/8毫克以上)3个值 string 传1/2/3
  • 响应示例: -- 返回结果 code :0 其中code代表返回结果,0代表成功。1表示不成功。post请求

    返回结果示例

{
	"count": 0, 
	"code":0,
	"msg":"",
	"data":[{
        "goodsId":"商品id",
        "goodsName":"商品名称",
        "pack_price": "每盒价格",
 		"carton_price": "整条价格",
 	    "mainImg": "主图"
	}]
}

7.查看商品详情

  • 接口名:MainServlet
  • 功能说明:
字段名 说明 参数类型 备注
method getGoodsDetail string 传String类型
goodsId 商品id String 传String类型
  • 响应示例: -- 返回结果 code :0 其中code代表返回结果,0代表成功。1表示不成功。post请求

返回结果示例

{
	"count": 0, 
	"code":0,
	"msg":"",
	"data":{
        "id":"编号",
 		 "goodsName":"商品名称",
 		 "brand": "品牌",
 		 "pack_price": "每盒价格",
 		 "carton_price": "整条价格",
 		 "productionArea": "产地",
 		 "type":"类别",
 		 "tar": "焦油含量",
 		 "newArrival": "是否为新品",
 		 "mainImg": "主图",
 		 "detailImg1": "详情图1",
 		 "detailImg2": "详情图2 ",
 		 "detailImg3": "详情图3",
 		 "detailImg4": "详情图4",
 		 "detailImg5": "详情图5",
 		 "model": "模型(短视频)"
	}
}

8.购物车下单

  • 接口名:WebUEditorServlet
  • 功能说明:订单表生成记录(支付时间及方式为空)及对应订单详情表
字段名 说明 参数类型 备注
method placeOrder string 传String类型
orderId 订单号 String 传String类型
detailJson 订单包含所有商品的详情序列 String 传json字符串数组
  • 响应示例: -- 返回结果 code :0 其中code代表返回结果,0代表成功。1表示不成功。post请求

    返回结果示例

{
	"count": 0, 
	"code":0,
	"msg":"",
	"data":""   
}

注:上传的detailJson字符串格式
{
    "result":[{
            "goodsId":"001",
            "unit":"pack/carton",
            "unitprice":"20",
            "count":"3",
            "subtotal":"60"
     	},{
             "goodsId":"002",
             "unit":"pack/carton",
             "unitprice":"10",
             "count":"2",
             "subtotal":"20"
     }]
 }

9.成功支付

  • 接口名:MainServlet
  • 功能说明:订单表生成记录(支付时间及方式为空)及对应订单详情表
字段名 说明 参数类型 备注
method paySuccess string 传String类型
orderId 订单号 String 传String类型
payTime 支付时间(2019-09-01 14:00) String 传String类型
sum 总金额 float 传float类型
payType 支付方式(WeChat/Alipay) string 传string类型
  • 响应示例: -- 返回结果 code :0 其中code代表返回结果,0代表成功。1表示不成功。post请求

    返回结果示例

{
	"count": 0, 
	"code":0,
	"msg":"",
	"data":""
    
}