天天看点

postman接口文档

  1. api

    基准路径:http://localhost:8888/api/private/v1/

    除了登录接口,其他所有接口请求头必须设置为Authorization=token (token为登录成功后服务器返回的认证token)

    1.1. 登录

    1.1.1. 登录验证接口

    请求路径:login

    请求方法:post

    请求参数

    参数名 参数说明 备注

    username 用户名 不能为空

    password 密码 不能为空

    响应参数

    参数名 参数说明 备注

    id 用户ID

    rid 用户角色ID

    username 用户名

    mobile 手机号

    email 邮箱

    token 令牌 基于jwt的令牌

    响应数据

    {

    “data”: {

    “id”: 500,

    “rid”: 0,

    “username”: “admin”,

    “mobile”: “123”,

    “email”: "[email protected]",

    “token”: “Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1aWQiOjUwMCwicmlkIjowLCJpYXQiOjE1MTI1NDQyOTksImV4cCI6MTUxMjYzMDY5OX0.eGrsrvwHm-tPsO9r_pxHIQ5i5L1kX9RX444uwnRGaIM”

    },

    “meta”: {

    “msg”: “登录成功”,

    “status”: 200

    }

    }

    1.2. 用户管理

    1.2.1. 用户数据列表

    请求路径:users

    请求方法:get

    请求参数

    参数名 参数说明 备注

    query 查询参数 可以为空

    pagenum 当前页码 不能为空

    pagesize 每页显示条数 不能为空

    响应参数

    参数名 参数说明 备注

    totalpage 总记录数

    pagenum 当前页码

    users 用户数据集合

    响应数据

    {

    “data”: {

    “totalpage”: 5,

    “pagenum”: 4,

    “users”: [

    {

    “id”: 25,

    “username”: “tige117”,

    “mobile”: “18616358651”,

    “type”: 1,

    “openid”: “”,

    “email”: "[email protected]",

    “create_time”: “2017-11-09T20:36:26.000Z”,

    “modify_time”: null,

    “is_delete”: false,

    “is_active”: false

    }

    ]

    },

    “meta”: {

    “msg”: “获取成功”,

    “status”: 200

    }

    }

    1.2.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”: "[email protected]",

    “create_time”: “2017-11-10T03:47:13.533Z”,

    “modify_time”: null,

    “is_delete”: false,

    “is_active”: false

    },

    “meta”: {

    “msg”: “用户创建成功”,

    “status”: 201

    }

    }

    1.2.3. 修改用户状态

    请求路径:users/:uId/state/:type

    请求方法:put

    请求参数

    参数名 参数说明 备注

    uId 用户ID 不能为空携带在url中

    type 用户状态 不能为空携带在url中,值为true或者false

    响应数据

    {

    “data”: {

    “id”: 566,

    “rid”: 30,

    “username”: “admin”,

    “mobile”: “123456”,

    “email”: "[email protected]",

    “mg_state”: 0

    },

    “meta”: {

    “msg”: “设置状态成功”,

    “status”: 200

    }

    }

    1.2.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”: "[email protected]"

    },

    “meta”: {

    “msg”: “更新成功”,

    “status”: 200

    }

    }

    1.2.5. 编辑用户提交

    请求路径:users/:id

    请求方法:put

    请求参数

    参数名 参数说明 备注

    id 用户id 不能为空 参数是url参数:id

    email 邮箱 可以为空

    mobile 手机号 可以为空

    响应参数

    参数名 参数说明 备注

    id 用户ID

    role_id 角色ID

    mobile 手机号

    email 邮箱

    响应数据

    {

    “data”: {

    “id”: 503,

    “username”: “admin3”,

    “role_id”: 0,

    “mobile”: “111”,

    “email”: "[email protected]"

    },

    “meta”: {

    “msg”: “更新成功”,

    “status”: 200

    }

    }

    1.2.6. 删除单个用户

    请求路径:users/:id

    请求方法:delete

    请求参数

    参数名 参数说明 备注

    id 用户id 不能为空参数是url参数:id

    响应参数

    响应数据

    {

    “data”: null,

    “meta”: {

    “msg”: “删除成功”,

    “status”: 200

    }

    }

    1.2.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”: "[email protected]"

    },

    “meta”: {

    “msg”: “设置角色成功”,

    “status”: 200

    }

    }

    1.3. 权限管理

    1.3.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.3.2. 左侧菜单权限

    请求路径:menus

    请求方法:get

    响应数据

    {

    “data”: [

    {

    “id”: 101,

    “authName”: “商品管理”,

    “path”: null,

    “children”: [

    {

    “id”: 104,

    “authName”: “商品列表”,

    “path”: null,

    “children”: []

    }

    ]

    }

    “meta”: {

    “msg”: “获取菜单列表成功”,

    “status”: 200

    }

    }

    1.4. 角色管理

    1.4.1. 角色列表

    请求路径:roles

    请求方法:get

    响应数据说明

    o第一层为角色信息

    o第二层开始为权限说明,权限一共有3层权限

    响应数据

    {

    “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.4.2. 添加角色

    请求路径:roles

    请求方法:post

    请求参数

    参数名 参数说明 备注

    roleName 角色名称 不能为空

    roleDesc 角色描述 可以为空

    响应参数

    参数名 参数说明 备注

    roleId 角色ID

    roleName 角色名称

    roleDesc 角色描述

    响应数据

    {

    “data”: {

    “roleId”: 40,

    “roleName”: “admin2”,

    “roleDesc”: “admin2Desc”

    },

    “meta”: {

    “msg”: “创建成功”,

    “status”: 201

    }

    }

    1.4.3. 根据ID查询角色

    请求路径:roles/:id

    请求方法:get

    请求参数

    参数名 参数说明 备注

    :id 角色ID 不能为空携带在url中

    响应参数

    参数名 参数说明 备注

    roleId 角色ID

    roleName 角色名称

    roleDesc 角色描述

    响应数据

    {

    “data”: {

    “roleId”: 31,

    “roleName”: “测试角色”,

    “roleDesc”: “测试负责人”

    },

    “meta”: {

    “msg”: “获取成功”,

    “status”: 200

    }

    }

    1.4.4. 编辑提交角色

    请求路径:roles/:id

    请求方法:put

    请求参数

    参数名 参数说明 备注

    :id 角色ID 不能为空携带在url中

    roleName 角色名称 不能为空

    roleDesc 角色描述 可以为空

    响应数据

    {

    “data”: {

    “roleId”: 31,

    “roleName”: “测试角色”,

    “roleDesc”: “测试角色描述”

    },

    “meta”: {

    “msg”: “获取成功”,

    “status”: 200

    }

    }

    1.4.5. 删除角色

    请求路径:roles/:id

    请求方法:delete

    请求参数

    参数名 参数说明 备注

    :id 角色ID 不能为空携带在url中

    响应数据

    {

    “data”: null,

    “meta”: {

    “msg”: “删除成功”,

    “status”: 200

    }

    }

    1.4.6. 角色授权

    请求路径:roles/:roleId/rights

    请求方法:post

    请求参数

    参数名 参数说明 备注

    :roleId 角色ID 不能为空携带在url中

    rids 权限ID列表 以 , 分割的权限ID列表

    响应数据

    {

    “data”: null,

    “meta”: {

    “msg”: “更新成功”,

    “status”: 200

    }

    }

    1.4.7. 删除角色指定权限

    请求路径:roles/:roleId/rights/:rightId

    请求方法:delete

    请求参数

    参数名 参数说明 备注

    :roleId 角色ID 不能为空携带在url中

    :rightId 权限ID 不能为空携带在url中

    响应数据说明

    o返回当前所有拥有的角色信息

    响应数据

    {

    “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.5. 商品分类管理

    1.5.1. 商品数据列表

    请求路径:categories

    请求方法:get

    请求参数

    参数名 参数说明 备注

    type [1,2,3] 值:1,2,3分别表示显示一层二层三层分类列表

    响应参数

    参数名 参数说明 备注

    cat_id 分类ID

    cat_name 分类名称

    cat_pid 分类父ID

    cat_level 分类当前层级

    响应数据

    {

    “data”: [

    {

    “cat_id”: 1,

    “cat_name”: “手机相机”,

    “cat_pid”: 0,

    “cat_level”: 0

    },

    {

    “cat_id”: 2,

    “cat_name”: “电脑办公”,

    “cat_pid”: 0,

    “cat_level”: 0

    }

    ],

    “meta”: {

    “msg”: “获取成功”,

    “status”: 200

    }

    }

    1.5.2. 添加分类

    请求路径:categories

    请求方法:post

    请求参数

    参数名 参数说明 备注

    cat_pid 分类父ID 不能为空

    cat_name 分类名称 不能为空

    cat_level 分类层级 不能为空

    响应数据

    {

    “data”: {

    “cat_id”: 62,

    “cat_name”: “相框”,

    “cat_pid”: “1”,

    “cat_level”: “1”

    },

    “meta”: {

    “msg”: “创建成功”,

    “status”: 201

    }

    }

    1.5.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.5.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.5.5. 删除分类

    请求路径:categories/:id

    请求方法:delete

    请求参数

    参数名 参数说明 备注

    :id 分类ID 不能为空携带在url中

    响应数据

    {

    “data”: null,

    “meta”: {

    “msg”: “删除成功”,

    “status”: 200

    }

    }

    1.6. 分类参数管理

    1.6.1. 参数列表

    请求路径:/:id/attributes

    请求方法:get

    请求参数

    参数名 参数说明 备注

    :id 分类ID 不能为空携带在url中

    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,那么有值,该值以逗号分隔

    响应数据

    {

    “data”: [

    {

    “attr_id”: 1,

    “attr_name”: “cpu”,

    “cat_id”: 22,

    “attr_sel”: “only”,

    “attr_write”: “manual”,

    “attr_vals”: “ffff”

    }

    ],

    “meta”: {

    “msg”: “获取成功”,

    “status”: 200

    }

    }

    1.6.2. 添加参数

    请求路径:/: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.6.3. 删除参数

    请求路径:/:id/attributes/:attrid

    请求方法:delete

    请求参数

    参数名 参数说明 备注

    :id 分类ID 不能为空携带在url中

    :attrid 参数ID 不能为空携带在url中

    响应数据

    {

    “data”: null,

    “meta”: {

    “msg”: “删除成功”,

    “status”: 200

    }

    }

    1.6.4. 根据ID查询参数

    请求路径:/: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.6.5. 编辑提交参数

    请求路径:/:id/attributes/:attrId

    请求方法:put

    请求参数

    参数名 参数说明 备注

    :id 分类ID 不能为空携带在url中

    :attrId 属性ID 不能为空携带在url中

    响应数据

    {

    “data”: {

    “attr_id”: 9,

    “attr_name”: “测试更新”,

    “cat_id”: “43”,

    “attr_sel”: “only”,

    “attr_write”: “manual”,

    “attr_vals”: “abc”

    },

    “meta”: {

    “msg”: “更新成功”,

    “status”: 200

    }

    }

    1.7. 商品管理

    1.7.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.7.2. 添加商品

    请求路径:goods

    请求方法:post

    请求参数

    参数名 参数说明 备注

    goods_name 商品名称 不能为空

    goods_cat 以为’,‘分割的分类列表 不能为空

    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_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.7.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.7.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.7.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

    Windows 点击下载

    1.8. 图片上传

    请求路径: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.9. 订单管理

    1.9.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.9.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已付款

    请求数据说明

    o所有请求数据都是增量更新,如果参数不填写,就不会更新该字段

    响应数据

    {

    “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.9.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. 数据统计

    1.10.1. 基于类型统计(饼图)

    请求路径:reports/:type

    请求方法:get

    响应数据

    1.10.2. 基于时间统计(折线图)

    请求路径:reports/:type

    请求方法:get

    响应数据

    1.10.3. 基于销量统计(柱状图)

    请求路径:reports/:type

    请求方法:get

    响应数据

继续阅读