商城管理接口文档

简介:商城管理接口文档

HOST:http://localhost:8080

联系人:hdq

Version:0.0.1

接口路径:/v3/api-docs

[TOC]

规格管理

新增规格

接口地址:/admin/skus

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "name": "尺寸",
  "order": 1,
  "status": 0,
  "standards": "S, M, L, XL, XXL",
  "type": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
skusAddDTO	新增规格时传递的数据模型	body	true	SkusAddDTO	SkusAddDTO
name	规格名称		true	string
order	排序		true	integer(int32)
status	状态（0：封禁,1：启动）		true	integer(int32)
standards	规格值		true	string
type	规格（0：无，1：颜色，0：图片）		true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

更新规格

接口地址:/admin/skus

请求方式:PUT

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "id": 12,
  "name": "尺寸",
  "order": 1,
  "status": 0,
  "standards": "S, M, L, XL, XXL",
  "type": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
skusEditDTO	编辑规格时传递的数据模型	body	true	SkusEditDTO	SkusEditDTO
id	规格id		true	integer(int64)
name	规格名称		true	string
order	排序		true	integer(int32)
status	状态（0：封禁,1：启动）		true	integer(int32)
standards	规格值		true	string
type	规格（0：无，1：颜色，0：图片）		true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

删除规格-批量删除

接口地址:/admin/skus

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ids		query	true	array	integer

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

分页查询规格

接口地址:/admin/skus/{page}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page		path	true	integer(int32)
pageSize		query	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	ResultPageResult

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		PageResult	PageResult
total		integer(int64)
records		array	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {
		"total": 0,
		"records": []
	}
}

权限管理

修改权限

接口地址:/admin/rule/{id}

请求方式:PUT

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "ruleId": 121,
  "order": 1,
  "condition": "createRule",
  "frontpath": "/front_path",
  "icon": "air",
  "menu": 0,
  "method": "GET",
  "name": "菜单名称",
  "status": 1
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		path	true	integer(int64)
ruleEditDTO	编辑权限时传递的数据模型	body	true	RuleEditDTO	RuleEditDTO
ruleId	规则id		false	integer(int64)
order	排序		false	integer(int32)
condition	后端规则		false	string
frontpath	前端路由		false	string
icon	图标		false	string
menu	菜单/权限（0：菜单，1：权限）		false	integer(int32)
method	请求方法		false	string
name	菜单名称		false	string
status	状态		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

删除权限

接口地址:/admin/rule/{id}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

查询权限列表

接口地址:/admin/rule

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	ResultListRuleInfoVO

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		array	RuleInfoVO
id		integer(int64)
ruleId		integer(int64)
status		integer(int32)
createTime		string(date-time)
updateTime		string(date-time)
name		string
desc		string
frontpath		string
condition		string
menu		integer(int32)
order		integer(int32)
icon		string
method		string

响应示例:

{
	"code": 0,
	"msg": "",
	"data": [
		{
			"id": 0,
			"ruleId": 0,
			"status": 0,
			"createTime": "",
			"updateTime": "",
			"name": "",
			"desc": "",
			"frontpath": "",
			"condition": "",
			"menu": 0,
			"order": 0,
			"icon": "",
			"method": ""
		}
	]
}

新增权限

接口地址:/admin/rule

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "ruleId": 121,
  "order": 1,
  "condition": "createRule",
  "frontpath": "/front_path",
  "icon": "air",
  "menu": 0,
  "method": "GET",
  "name": "菜单名称"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ruleAddDTO	新增权限时传递的数据模型	body	true	RuleAddDTO	RuleAddDTO
ruleId	规则id		true	integer(int64)
order	排序		true	integer(int32)
condition	后端规则		false	string
frontpath	前端路由		false	string
icon	图标		false	string
menu	菜单/权限（0：菜单，1：权限）		true	integer(int32)
method	请求方法		false	string
name	菜单名称		false	string

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

角色管理

查询角色列表

接口地址:/admin/role

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	ResultListRoleXiaLaListVO

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		array	RoleXiaLaListVO
id		integer(int64)
name		string

响应示例:

{
	"code": 0,
	"msg": "",
	"data": [
		{
			"id": 0,
			"name": ""
		}
	]
}

新增角色

接口地址:/admin/role

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "name": "超级管理员",
  "desc": "管理商品信息、添加/编辑商品、设置商品分类和标签、管理库存",
  "status": 1
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
roleAddDTO	新增角色时传递的数据模型	body	true	RoleAddDTO	RoleAddDTO
name	角色名		true	string
desc	介绍		true	string
status	状态		true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

更新角色

接口地址:/admin/role

请求方式:PUT

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "id": 121,
  "name": "超级管理员",
  "desc": "管理商品信息、添加/编辑商品、设置商品分类和标签、管理库存",
  "status": 1
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
roleEditDTO	编辑角色时传递的数据模型	body	true	RoleEditDTO	RoleEditDTO
id	角色id		true	integer(int64)
name	角色名		true	string
desc	介绍		true	string
status	状态		true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

删除角色-批量删除

接口地址:/admin/role

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ids		query	true	array	integer

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

分页查询角色列表

接口地址:/admin/role/{page}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page		path	true	integer(int32)
pageSize		query	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	ResultPageResult

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		PageResult	PageResult
total		integer(int64)
records		array	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {
		"total": 0,
		"records": []
	}
}

公告管理

新增公告

接口地址:/admin/notice

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "title": "公告标题",
  "content": "公告内容",
  "order": 1
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
noticeAddDTO	新增公告时传递的数据模型	body	true	NoticeAddDTO	NoticeAddDTO
title	标题		true	string
content	内容		true	string
order	排序		true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

更新公告

接口地址:/admin/notice

请求方式:PUT

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "id": 1221,
  "title": "公告标题",
  "content": "公告内容",
  "order": 1
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
noticeEditDTO	编辑公告时传递的数据模型	body	true	NoticeEditDTO	NoticeEditDTO
id	公告id		true	integer(int64)
title	标题		true	string
content	内容		true	string
order	排序		true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

删除公告-批量删除

接口地址:/admin/notice

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ids		query	true	array	integer

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

分页查询公告

接口地址:/admin/notice/{page}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page		path	true	integer(int32)
pageSize		query	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	ResultPageResult

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		PageResult	PageResult
total		integer(int64)
records		array	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {
		"total": 0,
		"records": []
	}
}

管理员管理

编辑管理员

接口地址:/admin/manager/{id}

请求方式:PUT

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "username": "admin",
  "password": "admin",
  "avatar": "https://shop-admin-hdq.oss-cn-beijing.aliyuncs.com/16cb6e46-13cc-4b9a-a82b-f51e16d4fb68.png",
  "roleId": 23,
  "status": 1
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		path	true	integer(int64)
managerEditDTO	编辑新增管理员时传递的数据模型	body	true	ManagerEditDTO	ManagerEditDTO
username	用户名		true	string
password	密码		true	string
avatar	头像		true	string
roleId	角色id		true	integer(int64)
status	角色封禁状态（0：封禁，1：解封）		true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

封禁管理员

接口地址:/admin/manager/banned

请求方式:PUT

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ids		query	true	array	integer
status		query	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

新增管理员

接口地址:/admin/manager

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "username": "admin",
  "password": "admin",
  "avatar": "https://shop-admin-hdq.oss-cn-beijing.aliyuncs.com/16cb6e46-13cc-4b9a-a82b-f51e16d4fb68.png",
  "roleId": 23,
  "status": 1
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
managerAddDTO	新增管理员时传递的数据模型	body	true	ManagerAddDTO	ManagerAddDTO
username	用户名		true	string
password	密码		true	string
avatar	头像		true	string
roleId	角色id		true	integer(int32)
status	角色封禁状态（0：封禁，1：解封）		true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

删除管理员-批量删除

接口地址:/admin/manager

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ids		query	true	array	integer

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

查询管理员列表

接口地址:/admin/manager/{page}

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "username": "胡歌",
  "status": 1,
  "roleId": 1,
  "createManagerId": 1,
  "lastUpdateManagerId": 1
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page		path	true	integer(int32)
pageSize		query	true	integer(int32)
managerFilterFormDTO	管理员过滤表单时传递的数据模型	body	true	ManagerFilterFormDTO	ManagerFilterFormDTO
username	管理员名		false	string
status	管理员状态		false	integer(int32)
roleId	角色id		false	integer(int64)
createManagerId	创建管理员的管理员id		false	integer(int64)
lastUpdateManagerId	修改管理员的管理员id		false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	ResultPageResult

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		PageResult	PageResult
total		integer(int64)
records		array	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {
		"total": 0,
		"records": []
	}
}

退出登录

接口地址:/admin/manager/logout

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

登录

接口地址:/admin/manager/login

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "username": "胡歌",
  "password": "admin",
  "autologin": true
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
managerLoginDTO	管理员登录时传递的数据模型	body	true	ManagerLoginDTO	ManagerLoginDTO
username	用户名		true	string
password	密码		true	string
autologin	24小时免登录，true为免登录，false为token正常过期时间		true	boolean

响应状态:

状态码	说明	schema
200	OK	ResultManagerLoginVO

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		ManagerLoginVO	ManagerLoginVO
token	token	string

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {
		"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhZG1pbklkIjoxLCJleHAiOjE3MjEzNjgwMzJ9.cLPbbGx1mXiEyzGtVpxHvA-iSlVNrj70rJTFCzA51EM"
	}
}

查询管理员下拉列表

接口地址:/admin/manager/selectXiaLa

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

获取管理员信息和权限菜单

接口地址:/admin/manager/getInfo

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

图库分类管理

图库分类查询

接口地址:/admin/image_class

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	ResultListImageClass

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		array	ImageClass
id		integer(int64)
name		string
order		integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": [
		{
			"id": 0,
			"name": "",
			"order": 0
		}
	]
}

新增图库分类

接口地址:/admin/image_class

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "name": "新鲜果蔬",
  "order": 120
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
imageClassAddDTO	新增图库分类时传递的数据模型	body	true	ImageClassAddDTO	ImageClassAddDTO
name	图库分类名称		true	string
order	排序		true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	ResultImageClassAddVO

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		ImageClassAddVO	ImageClassAddVO
id		integer(int64)
name		string
order		integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {
		"id": 0,
		"name": "",
		"order": 0
	}
}

修改图库分类

接口地址:/admin/image_class

请求方式:PUT

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "id": 132,
  "name": "新鲜果蔬",
  "order": 120
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
imageClassEditDTO	编辑图库分类时传递的数据模型	body	true	ImageClassEditDTO	ImageClassEditDTO
id	图库分类id		true	integer(int64)
name	图库分类名称		true	string
order	排序		true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

图库分类分页查询

接口地址:/admin/image_class/{page}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page		path	true	integer(int32)
limit		query	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	ResultPageResult

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		PageResult	PageResult
total		integer(int64)
records		array	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {
		"total": 0,
		"records": []
	}
}

删除图片分类

接口地址:/admin/image_class/{id}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		path	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

图库管理

编辑图片

接口地址:/admin/image

请求方式:PUT

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "id": 132,
  "name": "黑羽盗一"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
imageEditDTO	编辑图片时传递的数据模型	body	true	ImageEditDTO	ImageEditDTO
id	图片id		true	integer(int64)
name	图片名称		true	string

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

查询图片

接口地址:/admin/image/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		path	true	integer(int64)
limit		query	true	integer(int32)
page		query	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	ResultPageResult

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		PageResult	PageResult
total		integer(int64)
records		array	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {
		"total": 0,
		"records": []
	}
}

新增图片

接口地址:/admin/image/{id}

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

[
  {
    "name": "怪盗基德",
    "url": "https://shop-admin-hdq.oss-cn-beijing.aliyuncs.com/d2db75be-8769-4d2e-bfaa-429363d6d1bf.png"
  }
]

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		path	true	integer(int64)
imageAddDTOs	新增图片时传递的数据模型	body	true	array	ImageAddDTO
name	图片名		true	string
url	图片网络资源路径		true	string

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

删除图片

接口地址:/admin/image/{id}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		path	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

图片上传

接口地址:/admin/image/upload

请求方式:POST

请求数据类型:multipart/form-data

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
file		query	true	array	file

响应状态:

状态码	说明	schema
200	OK	ImageUploadVO

响应参数:

参数名称	参数说明	类型	schema
name		string
url		string
path		string

响应示例:

[
	{
		"name": "",
		"url": "",
		"path": ""
	}
]

优惠卷管理

新增优惠卷

接口地址:/admin/coupon

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "name": "夏季促销",
  "type": 0,
  "value": 100,
  "total": 500,
  "status": 0,
  "order": 10,
  "desc": "夏季促销大甩卖",
  "minPrice": 9.9,
  "startTime": "",
  "endTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
couponAddDTO	新增优惠卷时传递的数据模型	body	true	CouponAddDTO	CouponAddDTO
name	优惠卷名称		true	string
type	类型：固定金额/百分比折扣 0固定金额 1百分比'		true	integer(int32)
value	面值（含义由类型决定‘元/折’）		true	number(bigdecimal)
total	发行量（		true	integer(int32)
status	状态（0 未开始,1 进行中,2 已结束）		true	integer(int32)
order	排序		true	integer(int32)
desc	描述		true	string
minPrice	最低消费价格		true	number(bigdecimal)
startTime	开始时间		true	string(date-time)
endTime	结束时间		true	string(date-time)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

更新优惠卷

接口地址:/admin/coupon

请求方式:PUT

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "id": 12,
  "name": "夏季促销",
  "type": 0,
  "value": 100,
  "total": 500,
  "status": 0,
  "order": 10,
  "desc": "夏季促销大甩卖",
  "minPrice": 9.9,
  "startTime": "",
  "endTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
couponEditDTO	编辑优惠卷时传递的数据模型	body	true	CouponEditDTO	CouponEditDTO
id	id		true	integer(int64)
name	优惠卷名称		true	string
type	类型：固定金额/百分比折扣 0固定金额 1百分比'		true	integer(int32)
value	面值（含义由类型决定‘元/折’）		true	number(bigdecimal)
total	发行量（		true	integer(int32)
status	状态（0 未开始,1 进行中,2 已结束）		true	integer(int32)
order	排序		true	integer(int32)
desc	描述		true	string
minPrice	最低消费价格		true	number(bigdecimal)
startTime	开始时间		true	string(date-time)
endTime	结束时间		true	string(date-time)

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

删除优惠卷-批量删除

接口地址:/admin/coupon

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ids		query	true	array	integer

响应状态:

状态码	说明	schema
200	OK	Result

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		object

响应示例:

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

分页查询优惠卷

接口地址:/admin/coupon/{page}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page		path	true	integer(int32)
pageSize		query	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	ResultPageResult

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
msg		string
data		PageResult	PageResult
total		integer(int64)
records		array	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {
		"total": 0,
		"records": []
	}
}