电商项目的接口文档（自己用）

最新推荐文章于 2024-03-18 14:07:30 发布
最新推荐文章于 2024-03-18 14:07:30 发布
阅读量3.4k 收藏 73
点赞数 3
分类专栏： 前端学习
原文链接：https://blog.csdn.net/weixin_43392489/article/details/107598958
版权

1. 电商管理后台 API 接口文档

1.1. API V1 接口说明

  • 接口基准地址：http://127.0.0.1:8888/api/private/v1/
  • 服务端已开启 CORS 跨域支持
  • API V1 认证统一使用 Token 认证
  • 需要授权的 API ，必须在请求头中使用 Authorization 字段提供 token 令牌
  • 使用 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.2.1. 登录验证接口

  • 请求路径：login
  • 请求方法：post
  • 请求参数
参数名参数说明备注
username用户名不能为空
password密码不能为空
  • 响应参数
参数名参数说明备注
id用户 ID
rid用户角色 ID
username用户名
mobile手机号
email邮箱
token令牌基于 jwt 的令牌
  • 响应数据
{
    "data": {
        "id": 500,
        "rid": 0,
        "username": "admin",
        "mobile": "123",
        "email": "123@qq.com",
        "token": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1aWQiOjUwMCwicmlkIjowLCJpYXQiOjE1MTI1NDQyOTksImV4cCI6MTUxMjYzMDY5OX0.eGrsrvwHm-tPsO9r_pxHIQ5i5L1kX9RX444uwnRGaIM"
    },
    "meta": {
        "msg": "登录成功",
        "status": 200
    }
}

1.3. 用户管理

1.3.1. 用户数据列表

  • 请求路径：users
  • 请求方法：get
  • 请求参数
参数名参数说明备注
query查询参数可以为空
pagenum当前页码不能为空
pagesize每页显示条数不能为空
  • 响应参数
参数名参数说明备注
totalpage总记录数
pagenum当前页码
users用户数据集合
  • 响应数据
{
    "data": {
        "totalpage": 5,
        "pagenum": 4,
        "users": [
            {
                "id": 25,
                "username": "tige117",
                "mobile": "18616358651",
                "type": 1,
                "email": "tige112@163.com",
                "create_time": "2017-11-09T20:36:26.000Z",
                "mg_state": true, // 当前用户的状态
                "role_name": "炒鸡管理员"
            }
        ]
    },
    "meta": {
        "msg": "获取成功",
        "status": 200
    }
}

1.3.2. 添加用户

  • 请求路径：users
  • 请求方法：post
  • 请求参数
参数名参数说明备注
username用户名称不能为空
password用户密码不能为空
email邮箱可以为空
mobile手机号可以为空
  • 响应参数
参数名参数说明备注
id用户 ID
rid用户角色 ID
username用户名
mobile手机号
email邮箱
  • 响应数据
{
    "data": {
        "id": 28,
        "username": "tige1200",
        "mobile": "test",
        "type": 1,
        "openid": "",
        "email": "test@test.com",
        "create_time": "2017-11-10T03:47:13.533Z",
        "modify_time": null,
        "is_delete": false,
        "is_active": false
    },
    "meta": {
        "msg": "用户创建成功",
        "status": 201
    }
}

1.3.3. 修改用户状态

  • 请求路径：users/:uId/state/:type
  • 请求方法：put
  • 请求参数
参数名参数说明备注
uId用户 ID不能为空携带在url中
type用户状态不能为空携带在url中，值为 true 或者 false
  • 响应数据
{
  "data": {
    "id": 566,
    "rid": 30,
    "username": "admin",
    "mobile": "123456",
    "email": "bb@itcast.com",
    "mg_state": 0
  },
  "meta": {
    "msg": "设置状态成功",
    "status": 200
  }
}

1.3.4. 根据 ID 查询用户信息

  • 请求路径：users/:id
  • 请求方法：get
  • 请求参数
参数名参数说明备注
id用户 ID不能为空携带在url中
  • 响应参数
参数名参数说明备注
id用户 ID
role_id角色 ID
mobile手机号
email邮箱
  • 响应数据
{
    "data": {
        "id": 503,
        "username": "admin3",
        "role_id": 0,
        "mobile": "00000",
        "email": "new@new.com"
    },
    "meta": {
        "msg": "查询成功",
        "status": 200
    }
}

1.3.5. 编辑用户提交

  • 请求路径：users/:id
  • 请求方法：put
  • 请求参数
参数名参数说明备注
id用户 id不能为空 参数是url参数:id
email邮箱可以为空
mobile手机号可以为空
  • 响应参数
参数名参数说明备注
id用户 ID
role_id角色 ID
mobile手机号
email邮箱
  • 响应数据
/* 200表示成功，500表示失败 */
{
    "data": {
        "id": 503,
        "username": "admin3",
        "role_id": 0,
        "mobile": "111",
        "email": "123@123.com"
    },
    "meta": {
        "msg": "更新成功",
        "status": 200
    }
}

1.3.6. 删除单个用户

  • 请求路径：users/:id
  • 请求方法：delete
  • 请求参数
参数名参数说明备注
id用户 id不能为空参数是url参数:id
  • 响应参数
  • 响应数据
{
    "data": null,
    "meta": {
        "msg": "删除成功",
        "status": 200
    }
}

1.3.7. 分配用户角色

  • 请求路径：users/:id/role
  • 请求方法：put
  • 请求参数
参数名参数说明备注
id用户 ID不能为空参数是url参数:id
rid角色 id不能为空参数body参数
  • 响应参数
参数名参数说明备注
id用户 ID
role_id角色 ID
mobile手机号
email邮箱
  • 响应数据
{
    "data": {
        "id": 508,
        "rid": "30",
        "username": "asdf1",
        "mobile": "123123",
        "email": "adfsa@qq.com"
    },
    "meta": {
        "msg": "设置角色成功",
        "status": 200
    }
}

1.4. 权限管理

1.4.1. 所有权限列表

  • 请求路径：rights/:type
  • 请求方法：get
  • 请求参数
参数名参数说明备注
type类型值 list 或 tree , list 列表显示权限, tree 树状显示权限,参数是url参数:type
  • 响应参数
参数名参数说明备注
id权限 ID
authName权限说明
level权限层级
pid权限父 ID
path对应访问路径
  • 响应数据 type=list
  {
    "data": [
        {
            "id": 101,
            "authName": "商品管理",
            "level": "0",
            "pid": 0,
            "path": null
        },
        {
            "id": 102,
            "authName": "订单管理",
            "level": "0",
            "pid": 0,
            "path": null
        }
    ],
    "meta": {
        "msg": "获取权限列表成功",
        "status": 200
    }
}

type=tree

  {
    data: [
      {
        id: 101,
        authName: '商品管理',
        path: null,
        pid: 0,
        children: [
          {
            id: 104,
            authName: '商品列表',
            path: null,
            pid: 101,
            children: [
              {
                id: 105,
                authName: '添加商品',
                path: null,
                pid: '104,101'
              }
            ]
          }
        ]
      }
    ],
    meta: {
      msg: '获取权限列表成功',
      status: 200
    }
  }

1.4.2. 左侧菜单权限

  • 请求路径：menus
  • 请求方法：get
  • 响应数据
{
    "data":
        {
            "id": 101,
            "authName": "商品管理",
            "path": null,
            "children": [
                {
                    "id": 104,
                    "authName": "商品列表",
                    "path": null,
                    "children": []
                }
            ]
        }
    "meta": {
        "msg": "获取菜单列表成功",
        "status": 200
    }
}

1.5. 角色管理

1.5.1. 角色列表

  • 请求路径：roles

  • 请求方法：get

  • 响应数据说明

    • 第一层为角色信息
    • 第二层开始为权限说明，权限一共有 3 层权限
    • 最后一层权限，不包含 children 属性

  • 响应数据

{
    "data": [
        {
            "id": 30,
            "roleName": "主管",
            "roleDesc": "技术负责人",
            "children": [
                {
                    "id": 101,
                    "authName": "商品管理",
                    "path": null,
                    "children": [
                        {
                            "id": 104,
                            "authName": "商品列表",
                            "path": null,
                            "children": [
                                {
                                    "id": 105,
                                    "authName": "添加商品",
                                    "path": null
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ],
    "meta": {
        "msg": "获取成功",
        "status": 200
    }
}

1.5.2. 添加角色

  • 请求路径：roles
  • 请求方法：post
  • 请求参数
参数名参数说明备注
roleName角色名称不能为空
roleDesc角色描述可以为空
  • 响应参数
参数名参数说明备注
roleId角色 ID
roleName角色名称
roleDesc角色描述
  • 响应数据
{
    "data": {
        "roleId": 40,
        "roleName": "admin2",
        "roleDesc": "admin2Desc"
    },
    "meta": {
        "msg": "创建成功",
        "status": 201
    }
}

1.5.3. 根据 ID 查询角色

  • 请求路径：roles/:id
  • 请求方法：get
  • 请求参数
参数名参数说明备注
:id角色 ID不能为空携带在url中
  • 响应参数
参数名参数说明备注
roleId角色 ID
roleName角色名称
roleDesc角色描述
  • 响应数据
{
    "data": {
        "roleId": 31,
        "roleName": "测试角色",
        "roleDesc": "测试负责人"
    },
    "meta": {
        "msg": "获取成功",
        "status": 200
    }
}

1.5.4. 编辑提交角色

  • 请求路径：roles/:id
  • 请求方法：put
  • 请求参数
参数名参数说明备注
:id角色 ID不能为空携带在url中
roleName角色名称不能为空
roleDesc角色描述可以为空
  • 响应数据
{
    "data": {
        "roleId": 31,
        "roleName": "测试角色",
        "roleDesc": "测试角色描述"
    },
    "meta": {
        "msg": "获取成功",
        "status": 200
    }
}

1.5.5. 删除角色

  • 请求路径：roles/:id
  • 请求方法：delete
  • 请求参数
参数名参数说明备注
:id角色 ID不能为空携带在url中
  • 响应数据
{
    "data": null,
    "meta": {
        "msg": "删除成功",
        "status": 200
    }
}

1.5.6. 角色授权

  • 请求路径：roles/:roleId/rights
  • 请求方法：post
  • 请求参数：通过 请求体 发送给后端
参数名参数说明备注
:roleId角色 ID不能为空携带在url中
rids权限 ID 列表（字符串）以 , 分割的权限 ID 列表（获取所有被选中、叶子节点的key和半选中节点的key, 包括 1，2，3级节点）
  • 响应数据
{
    "data": null,
    "meta": {
        "msg": "更新成功",
        "status": 200
    }
}

1.5.7. 删除角色指定权限

  • 请求路径：roles/:roleId/rights/:rightId

  • 请求方法：delete

  • 请求参数

    参数名参数说明备注
    :roleId角色 ID不能为空携带在url中
    :rightId权限 ID不能为空携带在url中

  • 响应数据说明

    • 返回的data, 是当前角色下最新的权限数据

  • 响应数据

    {
    "data": [
        {
            "id": 101,
            "authName": "商品管理",
            "path": null,
            "children": [
                {
                    "id": 104,
                    "authName": "商品列表",
                    "path": null,
                    "children": [
                        {
                            "id": 105,
                            "authName": "添加商品",
                            "path": null
                        },
                        {
                            "id": 116,
                            "authName": "修改",
                            "path": null
                        }
                    ]
                }
            ]
        }
    ],
    "meta": {
        "msg": "取消权限成功",
        "status": 200
    }
}

1.6. 商品分类管理

1.6.1. 商品分类数据列表

  • 请求路径：categories
  • 请求方法：get
  • 请求参数
参数名参数说明备注
type[1,2,3]值：1，2，3 分别表示显示一层二层三层分类列表
【可选参数】如果不传递，则默认获取所有级别的分类
pagenum当前页码值【可选参数】如果不传递，则默认获取所有分类
pagesize每页显示多少条数据【可选参数】如果不传递，则默认获取所有分类
  • 响应参数
参数名参数说明备注
cat_id分类 ID
cat_name分类名称
cat_pid分类父 ID
cat_level分类当前层级
  • 响应数据
{
    "data": [
        {
            "cat_id": 1,
            "cat_name": "大家电",
            "cat_pid": 0,
            "cat_level": 0,
            "cat_deleted": false,
            "children": [
                {
                    "cat_id": 3,
                    "cat_name": "电视",
                    "cat_pid": 1,
                    "cat_level": 1,
                    "cat_deleted": false,
                    "children": [
                        {
                            "cat_id": 6,
                            "cat_name": "曲面电视",
                            "cat_pid": 3,
                            "cat_level": 2,
                            "cat_deleted": false
                        },
                        {
                            "cat_id": 7,
                            "cat_name": "海信",
                            "cat_pid": 3,
                            "cat_level": 2,
                            "cat_deleted": false
                        }
                    ]
                }
            ]
        }
    ],
    "meta": {
        "msg": "获取成功",
        "status": 200
    }
}

1.6.2. 添加分类

  • 请求路径：categories
  • 请求方法：post
  • 请求参数
参数名参数说明备注
cat_pid分类父 ID不能为空，如果要添加1级分类，则父分类Id应该设置为 0
cat_name分类名称不能为空
cat_level分类层级不能为空，0表示一级分类；1表示二级分类；2表示三级分类
  • 响应数据
{
    "data": {
        "cat_id": 62,
        "cat_name": "相框",
        "cat_pid": "1",
        "cat_level": "1"
    },
    "meta": {
        "msg": "创建成功",
        "status": 201
    }
}

1.6.3. 根据 id 查询分类

  • 请求路径：categories/:id
  • 请求方法：get
  • 请求参数
参数名参数说明备注
:id分类 ID不能为空携带在url中
  • 响应数据
{
    "data": {
        "cat_id": 3,
        "cat_name": "厨卫电器",
        "cat_pid": 0,
        "cat_level": 0
    },
    "meta": {
        "msg": "获取成功",
        "status": 200
    }
}

1.6.4. 编辑提交分类

  • 请求路径：categories/:id
  • 请求方法：put
  • 请求参数
参数名参数说明备注
:id分类 ID不能为空携带在url中
cat_name分类名称不能为空【此参数，放到请求体中】
  • 响应数据
{
    "data": {
        "cat_id": 22,
        "cat_name": "自拍杆",
        "cat_pid": 7,
        "cat_level": 2
    },
    "meta": {
        "msg": "更新成功",
        "status": 200
    }
}

1.6.5. 删除分类

  • 请求路径：categories/:id
  • 请求方法：delete
  • 请求参数
参数名参数说明备注
:id分类 ID不能为空携带在url中
  • 响应数据
{
    "data": null,
    "meta": {
        "msg": "删除成功",
        "status": 200
    }
}

1.7. 分类参数管理

1.7.1. 参数列表

  • 请求路径：categories/:id/attributes
  • 请求方法：get
  • 请求参数
参数名参数说明备注
:id分类 ID不能为空携带在url中
sel[only,many]不能为空,通过 only 或 many 来获取分类静态参数还是动态参数
  • 响应参数
参数名参数说明备注
attr_id分类参数 ID
attr_name分类参数名称
cat_id分类参数所属分类
attr_selonly:输入框(唯一) many:后台下拉列表/前台单选框
attr_writemanual:手工录入 list:从列表选择
attr_vals如果 attr_write:list,那么有值，该值以逗号分隔
  • 响应数据
{
    "data": [
        {
            "attr_id": 1,
            "attr_name": "cpu",
            "cat_id": 22,
            "attr_sel": "only",
            "attr_write": "manual",
            "attr_vals": "ffff"
        }
    ],
    "meta": {
        "msg": "获取成功",
        "status": 200
    }
}

1.7.2. 添加动态参数或者静态属性

  • 请求路径：categories/:id/attributes
  • 请求方法：post
  • 请求参数
参数名参数说明备注
:id分类 ID不能为空携带在url中
attr_name参数名称不能为空
attr_sel[only,many]不能为空
attr_vals如果是 many 就需要填写值的选项，以逗号分隔【可选参数】
  • 响应数据
{
    "data": {
        "attr_id": 44,
        "attr_name": "测试参数",
        "cat_id": "1",
        "attr_sel": "many",
        "attr_write": "list",
        "attr_vals": "a,b,c"
    },
    "meta": {
        "msg": "创建成功",
        "status": 201
    }
}

1.7.3. 删除参数

  • 请求路径： categories/:id/attributes/:attrid
  • 请求方法：delete
  • 请求参数
参数名参数说明备注
:id分类 ID不能为空携带在url中
:attrid参数 ID不能为空携带在url中
  • 响应数据
{
    "data": null,
    "meta": {
        "msg": "删除成功",
        "status": 200
    }
}

1.7.4. 根据 ID 查询参数

  • 请求路径：categories/:id/attributes/:attrId
  • 请求方法：get
  • 请求参数
参数名参数说明备注
:id分类 ID不能为空携带在url中
:attrId属性 ID不能为空携带在url中
attr_sel[only,many]不能为空
attr_vals如果是 many 就需要填写值的选项，以逗号分隔
  • 响应数据
{
    "data": {
        "attr_id": 1,
        "attr_name": "cpu",
        "cat_id": 22,
        "attr_sel": "only",
        "attr_write": "manual",
        "attr_vals": "ffff"
    },
    "meta": {
        "msg": "获取成功",
        "status": 200
    }
}

1.7.5. 编辑提交参数

  • 请求路径：categories/:id/attributes/:attrId
  • 请求方法：put
  • 请求参数
参数名参数说明备注
:id分类 ID不能为空携带在url中
:attrId属性 ID不能为空携带在url中
attr_name新属性的名字不能为空，携带在请求体中
attr_sel属性的类型[many或only]不能为空，携带在请求体中
attr_vals参数的属性值可选参数，携带在请求体中
  • 响应数据
{
    "data": {
        "attr_id": 9,
        "attr_name": "测试更新",
        "cat_id": "43",
        "attr_sel": "only",
        "attr_write": "manual",
        "attr_vals": "abc"
    },
    "meta": {
        "msg": "更新成功",
        "status": 200
    }
}

1.8. 商品管理

1.8.1. 商品列表数据

  • 请求路径：goods
  • 请求方法：get
  • 请求参数
参数名参数说明备注
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是否是热销品
  • 响应数据
{
    "data": {
        "total": 50,
        "pagenum": "1",
        "goods": [
            {
                "goods_id": 144,
                "goods_name": "asfdsd",
                "goods_price": 1,
                "goods_number": 1,
                "goods_weight": 1,
                "goods_state": null,
                "add_time": 1512954923,
                "upd_time": 1512954923,
                "hot_mumber": 0,
                "is_promote": false
            }
        ]
    },
    "meta": {
        "msg": "获取成功",
        "status": 200
    }
}

1.8.2. 添加商品

  • 请求路径：goods
  • 请求方法：post
  • 请求参数
参数名参数说明备注
goods_name商品名称不能为空
goods_cat以为’,'分割的分类列表不能为空
goods_price价格不能为空
goods_number数量不能为空
goods_weight重量不能为空
goods_introduce介绍可以为空
pics上传的图片临时路径（对象）可以为空
attrs商品的参数（数组），包含 动态参数 和 静态属性可以为空
  • 请求数据
{
  "goods_name":"test_goods_name2",
  "goods_cat": "1,2,3",
  "goods_price":20,
  "goods_number":30,
  "goods_weight":40,
  "goods_introduce":"abc",
  "pics":[
    {"pic":"/tmp_uploads/30f08d52c551ecb447277eae232304b8"}
    ],
  "attrs":[
    {
      "attr_id":15,
      "attr_value":"ddd"
    },
    {
      "attr_id":15,
      "attr_value":"eee"
    }
    ]
}
  • 响应参数
参数名参数说明备注
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:手动输入，还是单选,
  • 响应数据
{
    "data": {
        "goods_id": 145,
        "goods_name": "test_goods_name2",
        "goods_price": 20,
        "cat_id": 1,
        "goods_number": 30,
        "goods_weight": 40,
        "goods_introduce": "abc",
        "goods_big_logo": "",
        "goods_small_logo": "",
        "goods_state": 1,
        "add_time": 1512962370,
        "upd_time": 1512962370,
        "hot_mumber": 0,
        "is_promote": false,
        "pics": [
            {
                "pics_id": 397,
                "goods_id": 145,
                "pics_big": "uploads/goodspics/big_30f08d52c551ecb447277eae232304b8",
                "pics_mid": "uploads/goodspics/mid_30f08d52c551ecb447277eae232304b8",
                "pics_sma": "uploads/goodspics/sma_30f08d52c551ecb447277eae232304b8"
            }
        ],
        "attrs": [
            {
                "goods_id": 145,
                "attr_id": 15,
                "attr_value": "ddd",
                "add_price": null,
                "attr_name": "fffffff",
                "attr_sel": "many",
                "attr_write": "list",
                "attr_vals": ""
            },
            {
                "goods_id": 145,
                "attr_id": 15,
                "attr_value": "eee",
                "add_price": null,
                "attr_name": "fffffff",
                "attr_sel": "many",
                "attr_write": "list",
                "attr_vals": ""
            }
        ]
    },
    "meta": {
        "msg": "创建商品成功",
        "status": 201
    }
}

1.8.3. 根据 ID 查询商品

  • 请求路径：goods/:id
  • 请求方法：get
  • 请求参数
参数名参数说明备注
id商品 ID不能为空携带在url中
  • 响应参数
参数名参数说明备注
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:手动输入，还是单选,
  • 响应数据
{
    "data": {
        "goods_id": 145,
        "goods_name": "test_goods_name2",
        "goods_price": 20,
        "goods_number": 30,
        "goods_weight": 40,
        "goods_introduce": "abc",
        "goods_big_logo": "",
        "goods_small_logo": "",
        "goods_state": 1,
        "add_time": 1512962370,
        "upd_time": 1512962370,
        "hot_mumber": 0,
        "is_promote": false,
        "pics": [
            {
                "pics_id": 397,
                "goods_id": 145,
                "pics_big": "uploads/goodspics/big_30f08d52c551ecb447277eae232304b8",
                "pics_mid": "uploads/goodspics/mid_30f08d52c551ecb447277eae232304b8",
                "pics_sma": "uploads/goodspics/sma_30f08d52c551ecb447277eae232304b8"
            }
        ],
        "attrs": [
            {
                "goods_id": 145,
                "attr_id": 15,
                "attr_value": "ddd",
                "add_price": null,
                "attr_name": "fffffff",
                "attr_sel": "many",
                "attr_write": "list",
                "attr_vals": ""
            },
            {
                "goods_id": 145,
                "attr_id": 15,
                "attr_value": "eee",
                "add_price": null,
                "attr_name": "fffffff",
                "attr_sel": "many",
                "attr_write": "list",
                "attr_vals": ""
            }
        ]
    },
    "meta": {
        "msg": "创建商品成功",
        "status": 201
    }
}

1.8.4. 编辑提交商品

  • 请求路径：goods/:id
  • 请求方法：put
  • 请求参数
参数名参数说明备注
id商品 ID不能为空携带在url中
goods_name商品名称不能为空
goods_price价格不能为空
goods_number数量不能为空
goods_weight重量不能为空
goods_introduce介绍可以为空
pics上传的图片临时路径（对象）可以为空
attrs商品的参数（数组）可以为空
  • 请求数据
{
  "goods_name":"test_goods_name2",
  "goods_price":20,
  "goods_number":30,
  "goods_weight":40,
  "goods_introduce":"abc",
  "pics":[
    {"pic":"/tmp_uploads/30f08d52c551ecb447277eae232304b8"}
    ],
  "attrs":[
    {
      "attr_id":15,
      "attr_value":"ddd"
    },
    {
      "attr_id":15,
      "attr_value":"eee"
    }
    ]
}
  • 响应参数
参数名参数说明备注
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:手动输入，还是单选,
  • 响应数据
{
    "data": {
        "goods_id": 145,
        "goods_name": "test_goods_name2",
        "goods_price": 20,
        "goods_number": 30,
        "goods_weight": 40,
        "goods_introduce": "abc",
        "goods_big_logo": "",
        "goods_small_logo": "",
        "goods_state": 1,
        "add_time": 1512962370,
        "upd_time": 1512962370,
        "hot_mumber": 0,
        "is_promote": false,
        "pics": [
            {
                "pics_id": 397,
                "goods_id": 145,
                "pics_big": "uploads/goodspics/big_30f08d52c551ecb447277eae232304b8",
                "pics_mid": "uploads/goodspics/mid_30f08d52c551ecb447277eae232304b8",
                "pics_sma": "uploads/goodspics/sma_30f08d52c551ecb447277eae232304b8"
            }
        ],
        "attrs": [
            {
                "goods_id": 145,
                "attr_id": 15,
                "attr_value": "ddd",
                "add_price": null,
                "attr_name": "fffffff",
                "attr_sel": "many",
                "attr_write": "list",
                "attr_vals": ""
            },
            {
                "goods_id": 145,
                "attr_id": 15,
                "attr_value": "eee",
                "add_price": null,
                "attr_name": "fffffff",
                "attr_sel": "many",
                "attr_write": "list",
                "attr_vals": ""
            }
        ]
    },
    "meta": {
        "msg": "创建商品成功",
        "status": 201
    }
}

1.8.5. 删除商品

  • 请求路径：goods/:id
  • 请求方法：delete
  • 请求参数
参数名参数说明备注
id商品 ID不能为空携带在url中
  • 响应数据
{
    "data": null,
    "meta": {
        "msg": "删除成功",
        "status": 200
    }
}

###同步商品图片

  • 请求路径：goods/:id/pics
  • 请求方法：put
  • 请求参数
参数名参数说明备注
id商品 ID不能为空携带在url中
pics商品图片集合如果有 pics_id 字段会保留该图片，如果没有 pics_id 但是有 pic 字段就会新生成图片数据
  • 请求数据
;[
  { pic: 'tmp_uploads/db28f6316835836e97653b5c75e418be.png' },
  {
    pics_id: 397,
    goods_id: 145,
    pics_big: 'uploads/goodspics/big_30f08d52c551ecb447277eae232304b8',
    pics_mid: 'uploads/goodspics/mid_30f08d52c551ecb447277eae232304b8',
    pics_sma: 'uploads/goodspics/sma_30f08d52c551ecb447277eae232304b8'
  }
]
  • 响应数据
{
    "data": {
        "goods_id": 96,
        "goods_name": "iphoneXX",
        "goods_price": 2,
        "goods_number": 22,
        "goods_weight": 22,
        "goods_introduce": null,
        "goods_big_logo": "./uploads/goods/20171113/483a3b8e99e534ec3e4312dbbaee7c9d.jpg",
        "goods_small_logo": "./uploads/goods/20171113/small_483a3b8e99e534ec3e4312dbbaee7c9d.jpg",
        "goods_state": 0,
        "is_del": "1",
        "add_time": 1510045904,
        "upd_time": 1512635159,
        "delete_time": 1512635159,
        "hot_mumber": 0,
        "is_promote": false,
        "pics": [
            {
                "pics_id": 383,
                "goods_id": 96,
                "pics_big": "uploads/goodspics/big_6f5750132abd3f5b2b93dd722fcde653.jpg",
                "pics_mid": "uploads/goodspics/mid_6f5750132abd3f5b2b93dd722fcde653.jpg",
                "pics_sma": "uploads/goodspics/sma_6f5750132abd3f5b2b93dd722fcde653.jpg"
            }
        ],
        "attrs": [
            {
                "goods_id": 96,
                "attr_id": 15,
                "attr_value": "eee",
                "add_price": null,
                "attr_name": "fffffff",
                "attr_sel": "many",
                "attr_write": "list",
                "attr_vals": ""
            },
            {
                "goods_id": 96,
                "attr_id": 15,
                "attr_value": "ddd",
                "add_price": null,
                "attr_name": "fffffff",
                "attr_sel": "many",
                "attr_write": "list",
                "attr_vals": ""
            }
        ]
    },
    "meta": {
        "msg": "更新成功",
        "status": 200
    }
}

###同步商品属性

  • 请求路径：goods/:id/attributes
  • 请求方法：put
  • 请求参数
参数名参数说明备注
id商品 ID不能为空携带在url中
  • 请求数据
;[
  {
    attr_id: 15,
    attr_value: 'ddd'
  },
  {
    attr_id: 15,
    attr_value: 'eee'
  }
]
  • 响应数据
{
    "data": {
        "goods_id": 96,
        "goods_name": "iphoneXX",
        "goods_price": 2,
        "goods_number": 22,
        "goods_weight": 22,
        "goods_introduce": null,
        "goods_big_logo": "./uploads/goods/20171113/483a3b8e99e534ec3e4312dbbaee7c9d.jpg",
        "goods_small_logo": "./uploads/goods/20171113/small_483a3b8e99e534ec3e4312dbbaee7c9d.jpg",
        "goods_state": 0,
        "is_del": "1",
        "add_time": 1510045904,
        "upd_time": 1512635159,
        "delete_time": 1512635159,
        "hot_mumber": 0,
        "is_promote": false,
        "pics": [
            {
                "pics_id": 383,
                "goods_id": 96,
                "pics_big": "uploads/goodspics/big_6f5750132abd3f5b2b93dd722fcde653.jpg",
                "pics_mid": "uploads/goodspics/mid_6f5750132abd3f5b2b93dd722fcde653.jpg",
                "pics_sma": "uploads/goodspics/sma_6f5750132abd3f5b2b93dd722fcde653.jpg"
            }
        ],
        "attrs": [
            {
                "goods_id": 96,
                "attr_id": 15,
                "attr_value": "eee",
                "add_price": null,
                "attr_name": "fffffff",
                "attr_sel": "many",
                "attr_write": "list",
                "attr_vals": ""
            },
            {
                "goods_id": 96,
                "attr_id": 15,
                "attr_value": "ddd",
                "add_price": null,
                "attr_name": "fffffff",
                "attr_sel": "many",
                "attr_write": "list",
                "attr_vals": ""
            }
        ]
    },
    "meta": {
        "msg": "更新成功",
        "status": 200
    }
}

###商品图片处理必须安装 GraphicsMagick

  • linux
apt-get install GraphicsMagick
  • Mac OS X
brew install GraphicsMagick

1.9. 图片上传

  • 请求路径：upload
  • 请求方法：post
  • 请求参数
参数名参数说明备注
file上传文件
  • 响应数据
{
    "data": {
        "tmp_path": "tmp_uploads/ccfc5179a914e94506bcbb7377e8985f.png",
        "url": "http://127.0.0.1:8888tmp_uploads/ccfc5179a914e94506bcbb7377e8985f.png"
    },
    "meta": {
        "msg": "上传成功",
        "status": 200
    }
}

1.10. 订单管理

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发货地址可以为空
  • 响应数据
{
    "data": {
        "total": 1,
        "pagenum": "1",
        "goods": [
            {
                "order_id": 47,
                "user_id": 133,
                "order_number": "itcast-59e7502d7993d",
                "order_price": 322,
                "order_pay": "1",
                "is_send": "是",
                "trade_no": "",
                "order_fapiao_title": "个人",
                "order_fapiao_company": "",
                "order_fapiao_content": "办公用品",
                "consignee_addr": "a:7:{s:6:\"cgn_id\";i:1;s:7:\"user_id\";i:133;s:8:\"cgn_name\";s:9:\"王二柱\";s:11:\"cgn_address\";s:51:\"北京市海淀区苏州街长远天地大厦305室\";s:7:\"cgn_tel\";s:11:\"13566771298\";s:8:\"cgn_code\";s:6:\"306810\";s:11:\"delete_time\";N;}",
                "pay_status": "1",
                "create_time": 1508331565,
                "update_time": 1508331565
            }
        ]
    },
    "meta": {
        "msg": "获取成功",
        "status": 200
    }
}

1.10.2. 修改订单状态

  • 请求路径：orders/:id
  • 请求方法：put
  • 请求参数
参数名参数说明备注
id订单 ID不能为空携带在url中
is_send订单是否发货1:已经发货，0:未发货
order_pay订单支付支付方式 0 未支付 1 支付宝 2 微信 3 银行卡
order_price订单价格
order_number订单数量
pay_status支付状态订单状态： 0 未付款、1 已付款
  • 请求数据说明
    • 所有请求数据都是增量更新，如果参数不填写，就不会更新该字段
  • 响应数据
{
    "data": {
        "order_id": 67,
        "user_id": 1,
        "order_number": "itcast-g7kmck71vjaujfgoi",
        "order_price": 20,
        "order_pay": "0",
        "is_send": "否",
        "trade_no": "",
        "order_fapiao_title": "个人",
        "order_fapiao_company": "",
        "order_fapiao_content": "",
        "consignee_addr": "",
        "pay_status": "0",
        "create_time": 1512533560,
        "update_time": 1512533560,
        "goods": [
            {
                "id": 82,
                "order_id": 67,
                "goods_id": 96,
                "goods_price": 333,
                "goods_number": 2,
                "goods_total_price": 999
            },
            {
                "id": 83,
                "order_id": 67,
                "goods_id": 95,
                "goods_price": 666,
                "goods_number": 5,
                "goods_total_price": 999
            }
        ]
    },
    "meta": {
        "msg": "获取成功",
        "status": 200
    }
}

1.10.3. 查看订单详情

  • 请求路径：orders/:id
  • 请求方法：get
  • 请求参数
参数名参数说明备注
id订单 ID不能为空携带在url中
  • 响应数据
{
    "data": {
        "order_id": 67,
        "user_id": 1,
        "order_number": "itcast-g7kmck71vjaujfgoi",
        "order_price": 20,
        "order_pay": "0",
        "is_send": "否",
        "trade_no": "",
        "order_fapiao_title": "个人",
        "order_fapiao_company": "",
        "order_fapiao_content": "",
        "consignee_addr": "",
        "pay_status": "0",
        "create_time": 1512533560,
        "update_time": 1512533560,
        "goods": [
            {
                "id": 82,
                "order_id": 67,
                "goods_id": 96,
                "goods_price": 333,
                "goods_number": 2,
                "goods_total_price": 999
            },
            {
                "id": 83,
                "order_id": 67,
                "goods_id": 95,
                "goods_price": 666,
                "goods_number": 5,
                "goods_total_price": 999
            }
        ]
    },
    "meta": {
        "msg": "获取成功",
        "status": 200
    }
}

1.10.4. 修改地址

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

1.10.5. 查看物流信息

  • 请求路径：/kuaidi/:id

  • 请求方法：get

  • 供测试的物流单号：1106975712662

  • 响应数据：

    {
  "data": [
    {
      "time": "2018-05-10 09:39:00",
      "ftime": "2018-05-10 09:39:00",
      "context": "已签收,感谢使用顺丰,期待再次为您服务",
      "location": ""
    },
    {
      "time": "2018-05-10 08:23:00",
      "ftime": "2018-05-10 08:23:00",
      "context": "[北京市]北京海淀育新小区营业点派件员 顺丰速运 95338正在为您派件",
      "location": ""
    },
    {
      "time": "2018-05-10 07:32:00",
      "ftime": "2018-05-10 07:32:00",
      "context": "快件到达 [北京海淀育新小区营业点]",
      "location": ""
    },
    {
      "time": "2018-05-10 02:03:00",
      "ftime": "2018-05-10 02:03:00",
      "context": "快件在[北京顺义集散中心]已装车,准备发往 [北京海淀育新小区营业点]",
      "location": ""
    },
    {
      "time": "2018-05-09 23:05:00",
      "ftime": "2018-05-09 23:05:00",
      "context": "快件到达 [北京顺义集散中心]",
      "location": ""
    },
    {
      "time": "2018-05-09 21:21:00",
      "ftime": "2018-05-09 21:21:00",
      "context": "快件在[北京宝胜营业点]已装车,准备发往 [北京顺义集散中心]",
      "location": ""
    },
    {
      "time": "2018-05-09 13:07:00",
      "ftime": "2018-05-09 13:07:00",
      "context": "顺丰速运 已收取快件",
      "location": ""
    },
    {
      "time": "2018-05-09 12:25:03",
      "ftime": "2018-05-09 12:25:03",
      "context": "卖家发货",
      "location": ""
    },
    {
      "time": "2018-05-09 12:22:24",
      "ftime": "2018-05-09 12:22:24",
      "context": "您的订单将由HLA（北京海淀区清河中街店）门店安排发货。",
      "location": ""
    },
    {
      "time": "2018-05-08 21:36:04",
      "ftime": "2018-05-08 21:36:04",
      "context": "商品已经下单",
      "location": ""
    }
  ],
  "meta": { "status": 200, "message": "获取物流信息成功！" }
}

1.11. 数据统计

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

  • 请求路径：reports/type/1

  • 请求方法：get

  • 响应数据

  • 需要合并的选项

    options: {
        title: {
          text: '用户来源'
        },
        tooltip: {
          trigger: 'axis',
          axisPointer: {
            type: 'cross',
            label: {
              backgroundColor: '#E9EEF3'
            }
          }
        },
        grid: {
          left: '3%',
          right: '4%',
          bottom: '3%',
          containLabel: true
        },
        xAxis: [
          {
            boundaryGap: false
          }
        ],
        yAxis: [
          {
            type: 'value'
          }
        ]
      }
十年尚可
关注
  • 3
    点赞
  • 踩
  • 73
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
ShopXO免费开源商城1.8.0版本数据库设计文档
03-09
ShopXO免费开源商城是一个以 apache2.0协议发布开源、可商用、可二次开发的电商系统，本文档主要是整理了 v1.8.0版本数据库设计文档、表、字段+完整的备注
微商城后端接口项目包含API接口说明文档等
06-15
微商城后端接口项目，包含服务器搭建说明，所需的软件以及API接口说明文档
有哪些好用的电商API接口（京东|天猫|淘宝商品详情数据接口）
Fly2024124的博客
03-18 422
电商API接口主要用于帮助开发者将电商功能集成到自己的应用程序中，实现诸如商品检索、商品价格数据获取、订单处理、支付、物流跟踪等功能。提供淘宝、天猫、1688等阿里巴巴集团旗下的电商平台接口，用于商品检索、订单管理、物流跟踪等。京东对外提供了丰富的API接口，便于第三方开发者获取商品信息、订单状态、物流详情等。API接口调用灵活，可传入参数:关键词、商城、分类、品牌、价格区间、价格或销量排序等；·API接口返回的价格可返回优惠叠加计算后的到手价(正常只返回面价，到手价可选配)；
一套完整的社群电商系统，后端Api、后台管理系统、前台h5系统、小程序和App.zip
08-10
基于微信小程序构建的web应用系统，适合毕业设计、课程设计及大作业等。 基于微信小程序构建的web应用系统，适合毕业设计、课程设计及大作业等。 基于微信小程序构建的web应用系统，适合毕业设计、课程设计及大作业等。 基于微信小程序构建的web应用系统，适合毕业设计、课程设计及大作业等。 基于微信小程序构建的web应用系统，适合毕业设计、课程设计及大作业等。基于微信小程序构建的web应用系统，适合毕业设计、课程设计及大作业等。基于微信小程序构建的web应用系统，适合毕业设计、课程设计及大作业等。基于微信小程序构建的web应用系统，适合毕业设计、课程设计及大作业等。基于微信小程序构建的web应用系统，适合毕业设计、课程设计及大作业等。基于微信小程序构建的web应用系统，适合毕业设计、课程设计及大作业等。基于微信小程序构建的web应用系统，适合毕业设计、课程设计及大作业等。基于微信小程序构建的web应用系统，适合毕业设计、课程设计及大作业等。基于微信小程序构建的web应用系统，适合毕业设计、课程设计及大作业等。
SSM框架VUE实现B2C电商项目
12-23
开发环境 操作系统：Windows 10 Enterprise 开发工具：Intellij IDEA 数据库：MySQL 8.0.13 Java SDK：Oracle JDK 1.8.152 项目管理工具 项目构建：Maven 代码管理：Git 后台主要技术栈 核心框架：Spring + Spring MVC + MyBatis 数据库连接池：Alibaba Druid 数据库缓存：Redis 接口文档引擎：Swagger2 RESTful 风格 API 文档生成 全文检索引擎：Elasticsearch 系统任务调度：Quartz 前后分离 前端框架：NodeJS + Vue + Axios
电商管理后台 API 接口文档.md
07-18
电商管理后台 API 接口文档
服务器接口对接文档模板
09-29
该文档是后台服务器服务于客户端的接口对接说明文档，内容洁净、详细、言简意赅，可自定义或丰富其内容。是后台服务器开发人员不可缺少的好文档。
对接接口文档过程及感受
liulangzhezhang的博客
02-23 957
对接接口文档
接口对接文档规范2023年最新版（Restful API风格）
01-03 2440
使用Restful API风格,Restful API的优势是具备更好的易用性，让异构系统更容易集成，且开发执行效率比较高，面向资源要求也比较高。
前后端接口对接规范文档【推荐】
耶稣与梦的博客
02-24 2174
前后端交互接口遵循统一接口原则，构建优良的,默认使用POST方式发送请求，文件下载采用GET方式请求目的：降低沟通成本，减少不必要的扯皮，加快开发进度；缩短联调时间，减少联调阶段的代码调整，保证开发效率；减少测试阶段排查问题的归属，加快测试进度，保证质量；易于故障排除和在线修复。总结：如果你发现前端处理的逻辑很多，那就是协作规范有问题！前端更注重交互和渲染的逻辑，应该尽量避免复杂的业务逻辑处理。万事开头难！推一套规范需要时间，前端和后端的同事都要多一些耐心和理解。
api接口文档
weixin_45883559的博客
03-12 6360
api首页每日推荐最新挂出最新需求商品需求我的 首页 每日推荐 简要描述:随便4个商品 请求URL: https://yuyangstudy.xyz/home/recommend 请求方式: GET 参数: 无 返回参数: 参数名 类型 说明 goods_name string 商品名字 image_src string 图片路径 goods_id number 商品id 返回示例: { "message":[ { "image_src":"https://y
某电商项目接口文档
10-26
请勿下载，已不能使用！！！请勿下载，已不能使用！！！请勿下载，已不能使用！！！
ShopXO免费开源商城uniapp端主题源码、支持(微信+支付宝+百度+头条&抖音+QQ)小程序、H5、APP.zip
02-25
如题，抖音小程序源码，易于运行部署，用于学习交流
电商项目服务端客户端源码
06-02
红孩子电商服务端源码，客户端源码，很好的android学习资料！
ShopXO电商系统 1.3.0.zip
05-27
ShopXO是国内领先企业级B2C开源电商系统，遵循Apache2开源协议发布，无需授权、可商用、满足99%的电商运营需求。ShopXO电商系统 1.3.0 更新日志：2019-02-231.支持应用管理、上传安装、创建应用；2.顶部公告改为应用；3.用户中心公告改为应用；4.回到顶部改为应用；5.新增顶部大图广告应用；6.新增用户登录奖励积分应用；7.新增右侧快捷导航应用；8.新增在线客服应用；9.新增SQL控制台；10.其它细节优化。
电商管理后台 API 接口文档
01-27
电商管理后台 API 接口文档
支付宝接口对接说明文档
07-10
支付宝接口说明文档，可根据该文档配置与支付宝接口对接
电商平台项目实例设计文档功能清单RP原型DB定义书.zip
03-28
0-电商平台系统俯视图.pdf 1-电商平台系统全貌图.pdf AxureUX后台业务管理系统结构图.mmap 商品批量上传模板.csv 商品配货单.xlsx ...电商项目基础数据管理表.xlsx 订单配货单.xlsx 跨境电商原型（部分）.rp
ChatGPT4.0知识问答、DALL-E生成AI图片、Code Copilot辅助编程，打开新世界的大门.txt
最新发布
04-30
ChatGPT4.0知识问答、DALL-E生成AI图片、Code Copilot辅助编程，打开新世界的大门
电商管理后台 api 接口文档.md
07-23
### 回答1： 电商管理后台 API 接口文档是用来规定电商管理后台与其他系统进行数据交互的接口文档。该文档包含了所有可用接口的详细说明和调用方法。 接口文档主要分为以下几个部分： 1. 接口概述：对整个接口文档进行简要介绍，包括接口的作用、适用范围和目标用户等。 2. 接口列表：列出了所有可用的接口，包括接口名称、功能描述和请求方式等，方便开发人员查找和使用接口。 3. 接口详细说明：针对每个接口，提供详细的说明，包括请求参数、响应参数、调用示例、错误码定义等内容。请求参数包括接口所需的必填参数和可选参数，响应参数包括接口返回的数据结构。调用示例展示了接口的具体调用方法和参数格式。错误码定义列出了接口可能返回的错误码及其含义，方便开发人员进行异常处理。 4. 接口权限控制：说明每个接口的访问权限，包括接口所需的认证方式和权限验证方式等，确保只有具备相应权限的用户才能调用接口。 5. 接口版本管理：介绍接口的版本控制方法，包括接口版本号的命名规则和切换方法，以便于接口的后续升级和维护。 通过阅读电商管理后台API接口文档，开发人员可以清楚地了解每个接口的功能、参数和调用方法，从而实现与其他系统之间的数据交互。接口文档的编写规范和清晰度对于不同团队的协作和项目开发至关重要，保证了接口的准确性和可用性。因此，电商管理后台API接口文档是开发人员必备的参考资料，也是保障系统稳定运行和功能扩展的重要工具。 ### 回答2： 《电商管理后台api接口文档.md》是一份详细描述电商管理后台api接口的文档。这份文档主要内容包括接口名称、接口地址、请求方法、请求参数、返回参数、错误码以及权限控制等信息。 文档以清晰结构和简洁语言呈现，方便开发人员了解和使用接口。首先，文档列出了每个接口的名称，这有助于开发人员快速定位所需接口。接着，每个接口都附有一个准确的接口地址，开发人员可直接使用该地址来调用接口。 接口的请求方法部分列出了支持的请求方法，如GET、POST等，开发人员根据实际情况选择合适的方法。接口的请求参数包括必填参数和可选参数，文档对每个参数都进行了详细说明，包括参数名、类型、说明等。 文档的返回参数部分描述了接口的响应数据结构，开发人员可根据返回参数自行处理数据。错误码部分列举了可能出现的错误码及其含义，这有助于开发人员在出现错误时快速定位问题。 最后，文档还涉及权限控制，即某些接口可能需要特定的权限才能调用。文档对每个接口的权限要求进行了明确说明，以便开发人员了解并设置相应权限。 综上所述，《电商管理后台api接口文档.md》是一份非常重要的文档，对于电商管理后台的开发和维护工作起到了重要的参考作用。开发人员可以通过该文档了解接口的使用方法和参数要求，以快速、准确地完成开发任务。 ### 回答3： 电商管理后台 API 接口文档是一份规范及说明，用于指导开发人员在电商管理后台系统中使用 API 接口进行开发和集成。这份文档提供了系统中各个模块的接口文档，包括接口的请求参数、响应参数、接口功能描述等信息，帮助开发人员理解和正确使用接口。 该文档首先介绍了整个系统的基本信息，包括系统的架构、技术选型、接口鉴权机制等。然后，针对每个模块提供了相应的接口文档，包括但不限于用户管理、商品管理、订单管理等模块。接口文档中详细列出了每个接口的请求方法、请求路径、请求参数、响应参数等信息，以及每个接口的功能描述，帮助开发人员理解接口的用途和使用方法。 该文档还提供了一些常见的接口使用示例，指导开发人员如何正确地调用接口。同时，接口文档中也提供了一些注意事项和约束，帮助开发人员避免一些常见的错误和问题。 通过阅读和遵循电商管理后台 API 接口文档，开发人员可以更加方便地进行开发和集成工作。该文档的存在可以减少开发人员与产品经理、后端开发人员之间的沟通成本，提高开发效率，保证系统的正常运行和稳定性。 总之，电商管理后台 API 接口文档是一份重要的开发文档，对于系统的开发和集成具有指导作用，能够帮助开发人员更好地理解和使用系统的接口，并有效地进行开发和集成工作。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值