推广 热搜： 行业  机械  设备  杯  经纪  教师  系统  参数  金  蒸汽 
首页 > 最新动态 > 相关推荐

Vue电商系统后台API接口

   日期：2024-11-11     移动：http://yejunbin01.xhstdz.com/mobile/quote/78188.html

项目演示入口 ===>

Vue电商系统后台API接口

  • 接口基准地址：
  • 服务端已开启 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. 通用返回状态说明

状态码含义说明200OK请求成功201CREATED创建成功204DELETED删除成功400BAD REQUEST请求的地址不存在或者包含不支持的参数401UNAUTHORIZED未授权403FORBIDDEN被禁止访问404NOT FOUND请求的资源不存在422Unprocesable entity[POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误500INTERNAL SERVER ERROR内部错误

1.2.1. 登录验证接口

  • 请求路径：login
  • 请求方法：post
  • 请求参数
参数名参数说明备注username用户名不能为空password密码不能为空
  • 响应参数
参数名参数说明备注id用户 IDrid用户角色 IDusername用户名mobile手机号email邮箱token令牌基于 jwt 的令牌
  • 响应数据
 

1.3.1. 用户数据列表
 

  • 请求路径：users
  • 请求方法：get
  • 请求参数
 

参数名参数说明备注query查询参数可以为空pagenum当前页码不能为空pagesize每页显示条数不能为空
 

  • 响应参数
 

参数名参数说明备注totalpage总记录数pagenum当前页码users用户数据集合
 

  • 响应数据
 

 

1.3.2. 添加用户
 

  • 请求路径：users
  • 请求方法：post
  • 请求参数
 

参数名参数说明备注username用户名称不能为空password用户密码不能为空email邮箱可以为空mobile手机号可以为空
 

  • 响应参数
 

参数名参数说明备注id用户 IDrid用户角色 IDusername用户名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用户 IDrole_id角色 IDmobile手机号email邮箱
 

  • 响应数据
 

 

1.3.5. 编辑用户提交
 

  • 请求路径：users/:id
  • 请求方法：put
  • 请求参数
 

参数名参数说明备注id用户 id不能为空 email邮箱可以为空mobile手机号可以为空
 

  • 响应参数
 

参数名参数说明备注id用户 IDrole_id角色 IDmobile手机号email邮箱
 

  • 响应数据
 

 

1.3.6. 删除单个用户
 

  • 请求路径：users/:id
  • 请求方法：delete
  • 请求参数
 

参数名参数说明备注id用户 id不能为空
 

  • 响应参数
  • 响应数据
 

 

1.3.7. 分配用户角色
 

  • 请求路径：users/:id/role
  • 请求方法：put
  • 请求参数
 

参数名参数说明备注id用户 ID不能为空rid角色 id不能为空
 

  • 响应参数
 

参数名参数说明备注id用户 IDrole_id角色 IDmobile手机号email邮箱
 

  • 响应数据
 

 

1.4.1. 所有权限列表
 

  • 请求路径：rights/:type
  • 请求方法：get
  • 请求参数
 

参数名参数说明备注type类型值 list 或 tree , list 列表显示权限, tree 树状显示权限,
 

  • 响应参数
 

参数名参数说明备注id权限 IDauthName权限说明level权限层级pid权限父 IDpath对应访问路径
 

  • 响应数据 type=list
 

 

type=tree
 

 

1.4.2. 左侧菜单权限
 

  • 请求路径：menus
  • 请求方法：get
  • 响应数据
 

 

1.5.1. 角色列表
 

  •  
    请求路径：roles
     
  •  
    请求方法：get
     
  •  
    响应数据说明
     
  
    • 第一层为角色信息
     
  
    • 第二层开始为权限说明，权限一共有 3 层权限
    • 最后一层权限，不包含  属性
     
  •  
    响应数据
     
 

 

1.5.2. 添加角色
 

  • 请求路径：roles
  • 请求方法：post
  • 请求参数
 

参数名参数说明备注roleName角色名称不能为空roleDesc角色描述可以为空
 

  • 响应参数
 

参数名参数说明备注roleId角色 IDroleName角色名称roleDesc角色描述
 

  • 响应数据
 

 

1.5.3. 根据 ID 查询角色
 

  • 请求路径：roles/:id
  • 请求方法：get
  • 请求参数
 

参数名参数说明备注:id角色 ID不能为空
 

  • 响应参数
 

参数名参数说明备注roleId角色 IDroleName角色名称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. 删除角色指定权限
 

  •  
    请求路径：roles/:roleId/rights/:rightId
     
  •  
    请求方法：delete
     
  •  
    请求参数
     
  
    参数名参数说明备注:roleId角色 ID不能为空:rightId权限 ID不能为空
  •  
    响应数据说明
     
  
    • 返回的data, 是当前角色下最新的权限数据
     
  •  
    响应数据
     
     
 

1.6.1. 商品分类数据列表
 

  • 请求路径：categories
  • 请求方法：get
  • 请求参数
 

参数名参数说明备注type[1,2,3]值：1，2，3 分别表示显示一层二层三层分类列表【可选参数】如果不传递，则默认获取所有级别的分类pagenum当前页码值【可选参数】如果不传递，则默认获取所有分类pagesize每页显示多少条数据【可选参数】如果不传递，则默认获取所有分类
 

  • 响应参数
 

参数名参数说明备注cat_id分类 IDcat_name分类名称cat_pid分类父 IDcat_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分类参数 IDattr_name分类参数名称cat_id分类参数所属分类attr_selonly:输入框(唯一) many:后台下拉列表/前台单选框attr_writemanual:手工录入 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. 商品列表数据
 

  • 请求路径：goods
  • 请求方法：get
  • 请求参数
 

参数名参数说明备注query查询参数可以为空pagenum当前页码不能为空pagesize每页显示条数不能为空
 

  • 响应参数
 

参数名参数说明备注total总共商品条数pagenum当前商品页数goods_id商品 IDgoods_name商品名称goods_price价格goods_number数量goods_weight重量不能为空goods_state商品状态商品状态 0: 未通过 1: 审核中 2: 已审核add_time添加时间upd_time更新时间hot_mumber热销品数量is_promote是否是热销品
 

  • 响应数据
 

 

1.8.2. 添加商品
 

  • 请求路径：goods
  • 请求方法：post
  • 请求参数
 

参数名参数说明备注goods_name商品名称不能为空goods_cat以为’,'分割的分类列表不能为空goods_price价格不能为空goods_number数量不能为空goods_weight重量不能为空goods_introduce介绍可以为空pics上传的图片临时路径（对象）可以为空attrs商品的参数（数组），包含  和 可以为空
 

  • 请求数据
 

 

  • 响应参数
 

参数名参数说明备注total总共商品条数pagenum当前商品页数goods_id商品 IDgoods_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商品 IDgoods_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商品 IDgoods_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
 

  • linux
 

 

  • Mac OS X
 

 

  • Windows 点击下载
 

  • 请求路径：upload
  • 请求方法：post
  • 请求参数
 

参数名参数说明备注file上传文件
 

  • 响应数据
 

 

1.10.1. 订单数据列表
 

  • 请求路径：orders
  • 请求方法：get
  • 请求参数
 

参数名参数说明备注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. 修改地址
 

  1. 省市区/县联动效果 - 结合ElementUI的 el-cascader 组件
 

1.10.5. 查看物流信息
 

  •  
    请求路径：/kuaidi/:id
     
  •  
    请求方法：get
     
  •  
    供测试的物流单号：1106975712662
     
  •  
    响应数据：
     
     
 

1.11.1. 基于时间统计的折线图
 





特别提示：本信息由相关用户自行提供，真实性未证实，仅供参考。请谨慎采用，风险自负。







0 条相关评论











相关最新动态







推荐最新动态


    





点击排行















网站首页  |  
关于我们  |  
联系方式  |  
使用协议  |  
版权隐私  |  
网站地图  |  
排名推广  |  
广告服务  |  积分换礼  |  网站留言  |  RSS订阅  |   违规举报
  |  鄂ICP备2020018471号