- 接口基准地址:
- 服务端已开启 CORS 跨域支持
- API V1 认证统一使用 Token 认证
- 需要授权的 API ,必须在请求头中使用 字段提供 令牌
- 使用 HTTP Status Code 标识状态
- 数据返回格式统一使用 JSON
1.1.1. 支持的请求方法
- GET(SELECT):从服务器取出资源(一项或多项)。
- POST(CREATE):在服务器新建一个资源。
- PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。
- PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性)。
- DELETE(DELETE):从服务器删除资源。
- HEAD:获取资源的元数据。
- OPTIONS:获取信息,关于资源的哪些属性是客户端可以改变的。
1.1.2. 通用返回状态说明
状态码 | 含义 | 说明 |
---|
200 | OK | 请求成功 |
201 | CREATED | 创建成功 |
204 | DELETED | 删除成功 |
400 | BAD REQUEST | 请求的地址不存在或者包含不支持的参数 |
401 | UNAUTHORIZED | 未授权 |
403 | FORBIDDEN | 被禁止访问 |
404 | NOT FOUND | 请求的资源不存在 |
422 | Unprocesable entity | [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误 |
500 | INTERNAL SERVER ERROR | 内部错误 |
| | |
1.2.1. 登录验证接口
参数名 | 参数说明 | 备注 |
---|
username | 用户名 | 不能为空 |
password | 密码 | 不能为空 |
参数名 | 参数说明 | 备注 |
---|
id | 用户 ID | |
rid | 用户角色 ID | |
username | 用户名 | |
mobile | 手机号 | |
email | 邮箱 | |
token | 令牌 | 基于 jwt 的令牌 |
1.3.1. 用户数据列表
参数名 | 参数说明 | 备注 |
---|
query | 查询参数 | 可以为空 |
pagenum | 当前页码 | 不能为空 |
pagesize | 每页显示条数 | 不能为空 |
参数名 | 参数说明 | 备注 |
---|
totalpage | 总记录数 | |
pagenum | 当前页码 | |
users | 用户数据集合 | |
1.3.2. 添加用户
参数名 | 参数说明 | 备注 |
---|
username | 用户名称 | 不能为空 |
password | 用户密码 | 不能为空 |
email | 邮箱 | 可以为空 |
mobile | 手机号 | 可以为空 |
参数名 | 参数说明 | 备注 |
---|
id | 用户 ID | |
rid | 用户角色 ID | |
username | 用户名 | |
mobile | 手机号 | |
email | 邮箱 | |
1.3.3. 修改用户状态
- 请求路径:users/:uId/state/:type
- 请求方法:put
- 请求参数
参数名 | 参数说明 | 备注 |
---|
uId | 用户 ID | 不能为空 |
type | 用户状态 | 不能为空,值为 true 或者 false |
1.3.4. 根据 ID 查询用户信息
- 请求路径:users/:id
- 请求方法:get
- 请求参数
参数名 | 参数说明 | 备注 |
---|
id | 用户 ID | 不能为空 |
参数名 | 参数说明 | 备注 |
---|
id | 用户 ID | |
role_id | 角色 ID | |
mobile | 手机号 | |
email | 邮箱 | |
1.3.5. 编辑用户提交
- 请求路径:users/:id
- 请求方法:put
- 请求参数
参数名 | 参数说明 | 备注 |
---|
id | 用户 id | 不能为空 |
email | 邮箱 | 可以为空 |
mobile | 手机号 | 可以为空 |
参数名 | 参数说明 | 备注 |
---|
id | 用户 ID | |
role_id | 角色 ID | |
mobile | 手机号 | |
email | 邮箱 | |
1.3.6. 删除单个用户
- 请求路径:users/:id
- 请求方法:delete
- 请求参数
参数名 | 参数说明 | 备注 |
---|
id | 用户 id | 不能为空 |
1.3.7. 分配用户角色
- 请求路径:users/:id/role
- 请求方法:put
- 请求参数
参数名 | 参数说明 | 备注 |
---|
id | 用户 ID | 不能为空 |
rid | 角色 id | 不能为空 |
参数名 | 参数说明 | 备注 |
---|
id | 用户 ID | |
role_id | 角色 ID | |
mobile | 手机号 | |
email | 邮箱 | |
1.4.1. 所有权限列表
- 请求路径:rights/:type
- 请求方法:get
- 请求参数
参数名 | 参数说明 | 备注 |
---|
type | 类型 | 值 list 或 tree , list 列表显示权限, tree 树状显示权限, |
参数名 | 参数说明 | 备注 |
---|
id | 权限 ID | |
authName | 权限说明 | |
level | 权限层级 | |
pid | 权限父 ID | |
path | 对应访问路径 | |
type=tree
1.4.2. 左侧菜单权限
1.5.1. 角色列表
-
请求路径:roles
-
请求方法:get
-
响应数据说明
- 第二层开始为权限说明,权限一共有 3 层权限
- 最后一层权限,不包含 属性
-
响应数据
1.5.2. 添加角色
参数名 | 参数说明 | 备注 |
---|
roleName | 角色名称 | 不能为空 |
roleDesc | 角色描述 | 可以为空 |
参数名 | 参数说明 | 备注 |
---|
roleId | 角色 ID | |
roleName | 角色名称 | |
roleDesc | 角色描述 | |
1.5.3. 根据 ID 查询角色
- 请求路径:roles/:id
- 请求方法:get
- 请求参数
参数名 | 参数说明 | 备注 |
---|
:id | 角色 ID | 不能为空 |
参数名 | 参数说明 | 备注 |
---|
roleId | 角色 ID | |
roleName | 角色名称 | |
roleDesc | 角色描述 | |
1.5.4. 编辑提交角色
- 请求路径:roles/:id
- 请求方法:put
- 请求参数
参数名 | 参数说明 | 备注 |
---|
:id | 角色 ID | 不能为空 |
roleName | 角色名称 | 不能为空 |
roleDesc | 角色描述 | 可以为空 |
1.5.5. 删除角色
- 请求路径:roles/:id
- 请求方法:delete
- 请求参数
参数名 | 参数说明 | 备注 |
---|
:id | 角色 ID | 不能为空 |
1.5.6. 角色授权
- 请求路径:roles/:roleId/rights
- 请求方法:post
- 请求参数:通过 发送给后端
参数名 | 参数说明 | 备注 |
---|
:roleId | 角色 ID | 不能为空 |
rids | 权限 ID 列表(字符串) | 以 分割的权限 ID 列表(获取所有被选中、叶子节点的key和半选中节点的key, 包括 1,2,3级节点) |
1.5.7. 删除角色指定权限
1.6.1. 商品分类数据列表
- 请求路径:categories
- 请求方法:get
- 请求参数
参数名 | 参数说明 | 备注 |
---|
type | [1,2,3] | 值:1,2,3 分别表示显示一层二层三层分类列表【可选参数】如果不传递,则默认获取所有级别的分类 |
pagenum | 当前页码值 | 【可选参数】如果不传递,则默认获取所有分类 |
pagesize | 每页显示多少条数据 | 【可选参数】如果不传递,则默认获取所有分类 |
参数名 | 参数说明 | 备注 |
---|
cat_id | 分类 ID | |
cat_name | 分类名称 | |
cat_pid | 分类父 ID | |
cat_level | 分类当前层级 | |
1.6.2. 添加分类
- 请求路径:categories
- 请求方法:post
- 请求参数
参数名 | 参数说明 | 备注 |
---|
cat_pid | 分类父 ID | 不能为空,如果要添加1级分类,则父分类Id应该设置为 |
cat_name | 分类名称 | 不能为空 |
cat_level | 分类层级 | 不能为空,表示一级分类;表示二级分类;表示三级分类 |
1.6.3. 根据 id 查询分类
- 请求路径:categories/:id
- 请求方法:get
- 请求参数
参数名 | 参数说明 | 备注 |
---|
:id | 分类 ID | 不能为空 |
1.6.4. 编辑提交分类
- 请求路径:categories/:id
- 请求方法:put
- 请求参数
参数名 | 参数说明 | 备注 |
---|
:id | 分类 ID | 不能为空 |
cat_name | 分类名称 | 不能为空【此参数,放到请求体中】 |
1.6.5. 删除分类
- 请求路径:categories/:id
- 请求方法:delete
- 请求参数
参数名 | 参数说明 | 备注 |
---|
:id | 分类 ID | 不能为空 |
1.7.1. 参数列表
- 请求路径:categories/:id/attributes
- 请求方法:get
- 请求参数
参数名 | 参数说明 | 备注 |
---|
:id | 分类 ID | 不能为空 |
sel | [only,many] | 不能为空,通过 only 或 many 来获取分类静态参数还是动态参数 |
参数名 | 参数说明 | 备注 |
---|
attr_id | 分类参数 ID | |
attr_name | 分类参数名称 | |
cat_id | 分类参数所属分类 | |
attr_sel | only:输入框(唯一) many:后台下拉列表/前台单选框 | |
attr_write | manual:手工录入 list:从列表选择 | |
attr_vals | 如果 attr_write:list,那么有值,该值以逗号分隔 | |
1.7.2. 添加动态参数或者静态属性
- 请求路径:categories/:id/attributes
- 请求方法:post
- 请求参数
参数名 | 参数说明 | 备注 |
---|
:id | 分类 ID | 不能为空 |
attr_name | 参数名称 | 不能为空 |
attr_sel | [only,many] | 不能为空 |
attr_vals | 如果是 many 就需要填写值的选项,以逗号分隔 | 【可选参数】 |
1.7.3. 删除参数
- 请求路径: categories/:id/attributes/:attrid
- 请求方法:delete
- 请求参数
参数名 | 参数说明 | 备注 |
---|
:id | 分类 ID | 不能为空 |
:attrid | 参数 ID | 不能为空 |
1.7.4. 根据 ID 查询参数
- 请求路径:categories/:id/attributes/:attrId
- 请求方法:get
- 请求参数
参数名 | 参数说明 | 备注 |
---|
:id | 分类 ID | 不能为空 |
:attrId | 属性 ID | 不能为空 |
attr_sel | [only,many] | 不能为空 |
attr_vals | 如果是 many 就需要填写值的选项,以逗号分隔 | |
1.7.5. 编辑提交参数
- 请求路径:categories/:id/attributes/:attrId
- 请求方法:put
- 请求参数
参数名 | 参数说明 | 备注 |
---|
:id | 分类 ID | 不能为空 |
:attrId | 属性 ID | 不能为空 |
attr_name | 新属性的名字 | 不能为空,携带在中 |
attr_sel | 属性的类型[many或only] | 不能为空,携带在中 |
attr_vals | 参数的属性值 | 可选参数,携带在中 |
1.8.1. 商品列表数据
参数名 | 参数说明 | 备注 |
---|
query | 查询参数 | 可以为空 |
pagenum | 当前页码 | 不能为空 |
pagesize | 每页显示条数 | 不能为空 |
参数名 | 参数说明 | 备注 |
---|
total | 总共商品条数 | |
pagenum | 当前商品页数 | |
goods_id | 商品 ID | |
goods_name | 商品名称 | |
goods_price | 价格 | |
goods_number | 数量 | |
goods_weight | 重量 | 不能为空 |
goods_state | 商品状态 | 商品状态 0: 未通过 1: 审核中 2: 已审核 |
add_time | 添加时间 | |
upd_time | 更新时间 | |
hot_mumber | 热销品数量 | |
is_promote | 是否是热销品 | |
1.8.2. 添加商品
参数名 | 参数说明 | 备注 |
---|
goods_name | 商品名称 | 不能为空 |
goods_cat | 以为’,'分割的分类列表 | 不能为空 |
goods_price | 价格 | 不能为空 |
goods_number | 数量 | 不能为空 |
goods_weight | 重量 | 不能为空 |
goods_introduce | 介绍 | 可以为空 |
pics | 上传的图片临时路径(对象) | 可以为空 |
attrs | 商品的参数(数组),包含 和 | 可以为空 |
参数名 | 参数说明 | 备注 |
---|
total | 总共商品条数 | |
pagenum | 当前商品页数 | |
goods_id | 商品 ID | |
goods_cat | 以为’,'分割的分类列表 | |
goods_name | 商品名称 | |
goods_price | 价格 | |
goods_number | 数量 | |
goods_weight | 重量 | 不能为空 |
goods_state | 商品状态 | 商品状态 0: 未通过 1: 审核中 2: 已审核 |
add_time | 添加时间 | |
upd_time | 更新时间 | |
hot_mumber | 热销品数量 | |
is_promote | 是否是热销品 | |
pics | 上传的图片临时路径(对象) | pics_id:图片 ID,goods_id:商品 ID,pics_big:大图,pics_mid:中图,pics_sma:小图 |
attrs | 商品的参数(数组) | goods_id:商品 ID,attr_value:当前商品的参数值,add_price:浮动价格,attr_vals:预定义的参数值,attr_sel:手动输入,还是单选, |
1.8.3. 根据 ID 查询商品
- 请求路径:goods/:id
- 请求方法:get
- 请求参数
参数名 | 参数说明 | 备注 |
---|
id | 商品 ID | 不能为空 |
参数名 | 参数说明 | 备注 |
---|
total | 总共商品条数 | |
pagenum | 当前商品页数 | |
goods_id | 商品 ID | |
goods_name | 商品名称 | |
goods_price | 价格 | |
goods_number | 数量 | |
goods_weight | 重量 | 不能为空 |
goods_state | 商品状态 | 商品状态 0: 未通过 1: 审核中 2: 已审核 |
add_time | 添加时间 | |
upd_time | 更新时间 | |
hot_mumber | 热销品数量 | |
is_promote | 是否是热销品 | |
pics | 上传的图片临时路径(对象) | pics_id:图片 ID,goods_id:商品 ID,pics_big:大图,pics_mid:中图,pics_sma:小图 |
attrs | 商品的参数(数组) | goods_id:商品 ID,attr_value:当前商品的参数值,add_price:浮动价格,attr_vals:预定义的参数值,attr_sel:手动输入,还是单选, |
1.8.4. 编辑提交商品
- 请求路径:goods/:id
- 请求方法:put
- 请求参数
参数名 | 参数说明 | 备注 |
---|
id | 商品 ID | 不能为空 |
goods_name | 商品名称 | 不能为空 |
goods_price | 价格 | 不能为空 |
goods_number | 数量 | 不能为空 |
goods_weight | 重量 | 不能为空 |
goods_introduce | 介绍 | 可以为空 |
pics | 上传的图片临时路径(对象) | 可以为空 |
attrs | 商品的参数(数组) | 可以为空 |
参数名 | 参数说明 | 备注 |
---|
total | 总共商品条数 | |
pagenum | 当前商品页数 | |
goods_id | 商品 ID | |
goods_name | 商品名称 | |
goods_price | 价格 | |
goods_number | 数量 | |
goods_weight | 重量 | 不能为空 |
goods_state | 商品状态 | 商品状态 0: 未通过 1: 审核中 2: 已审核 |
add_time | 添加时间 | |
upd_time | 更新时间 | |
hot_mumber | 热销品数量 | |
is_promote | 是否是热销品 | |
pics | 上传的图片临时路径(对象) | pics_id:图片 ID,goods_id:商品 ID,pics_big:大图,pics_mid:中图,pics_sma:小图 |
attrs | 商品的参数(数组) | goods_id:商品 ID,attr_value:当前商品的参数值,add_price:浮动价格,attr_vals:预定义的参数值,attr_sel:手动输入,还是单选, |
1.8.5. 删除商品
- 请求路径:goods/:id
- 请求方法:delete
- 请求参数
参数名 | 参数说明 | 备注 |
---|
id | 商品 ID | 不能为空 |
###同步商品图片
- 请求路径:goods/:id/pics
- 请求方法:put
- 请求参数
参数名 | 参数说明 | 备注 |
---|
id | 商品 ID | 不能为空 |
pics | 商品图片集合 | 如果有 pics_id 字段会保留该图片,如果没有 pics_id 但是有 pic 字段就会新生成图片数据 |
###同步商品属性
- 请求路径:goods/:id/attributes
- 请求方法:put
- 请求参数
参数名 | 参数说明 | 备注 |
---|
id | 商品 ID | 不能为空 |
###商品图片处理必须安装 GraphicsMagick
参数名 | 参数说明 | 备注 |
---|
file | 上传文件 | |
1.10.1. 订单数据列表
参数名 | 参数说明 | 备注 |
---|
query | 查询参数 | 可以为空 |
pagenum | 当前页码 | 不能为空 |
pagesize | 每页显示条数 | 不能为空 |
user_id | 用户 ID | 可以为空 |
pay_status | 支付状态 | 可以为空 |
is_send | 是否发货 | 可以为空 |
order_fapiao_title | [‘个人’,‘公司’] | 可以为空 |
order_fapiao_company | 公司名称 | 可以为空 |
order_fapiao_content | 发票内容 | 可以为空 |
consignee_addr | 发货地址 | 可以为空 |
1.10.2. 修改订单状态
- 请求路径:orders/:id
- 请求方法:put
- 请求参数
参数名 | 参数说明 | 备注 |
---|
id | 订单 ID | 不能为空 |
is_send | 订单是否发货 | 1:已经发货,0:未发货 |
order_pay | 订单支付 | 支付方式 0 未支付 1 支付宝 2 微信 3 银行卡 |
order_price | 订单价格 | |
order_number | 订单数量 | |
pay_status | 支付状态 | 订单状态: 0 未付款、1 已付款 |
- 请求数据说明
- 所有请求数据都是增量更新,如果参数不填写,就不会更新该字段
- 响应数据
1.10.3. 查看订单详情
- 请求路径:orders/:id
- 请求方法:get
- 请求参数
参数名 | 参数说明 | 备注 |
---|
id | 订单 ID | 不能为空 |
1.10.4. 修改地址
- 省市区/县联动效果 - 结合ElementUI的 el-cascader 组件
1.10.5. 查看物流信息
-
请求路径:/kuaidi/:id
-
请求方法:get
-
供测试的物流单号:1106975712662
-
响应数据:
1.11.1. 基于时间统计的折线图
-
请求路径:reports/type/1
-
请求方法:get
-
响应数据
-
需要合并的选项