[bhpyg] Thinkphp5 品优购商城后台Restful接口文档

最新推荐文章于 2021-11-28 20:03:38 发布
最新推荐文章于 2021-11-28 20:03:38 发布
阅读量798 收藏 4
点赞数
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u011436748/article/details/112601190
版权

1. 域名

http://adminapi.xxx.com

其中，子域名必须为adminapi, xxx为自己配置的主域名

2.请求参数

请求参数 请以 “接口地址?参数名=参数值&参数名=参数值” 方式传递。

3.返回格式

所有 response 都固定的格式：{code: 200, msg: "success", data: []}

必有 code, msg, data 三个字段

code: 状态码。 200表示成功，3xx表示重定向，4xx表示请求错误，5xx表示服务器内部错误.

msg: 错误信息

data: 返回的具体数据。

下面所列出的接口 response 指 data 字段

4.列表数据

1.后端分页

返回数据中包含以下字段，表示支持后端分页功能

“total”: “总记录数”,
“per_page”: “每页显示数”,
“current_page”: “当前页码”,
“last_page”: “最大页码”,

请求参数中 传递page参数 获取指定页码数据，如page=2 获取第2页数据

2.列表数据结构

数据涉及到上下级关系的，分为以下三种数据结构：

普通列表结构list

[
	{"id":1,"pid":0, ...},
	{"id":2,"pid":0, ...},
	{"id":3,"pid":1, ...},
	{"id":4,"pid":2, ...},
]

无限级分类列表结构tree_list

[
	{"id":1,"pid":0, ...},//第一个一级
	{"id":3,"pid":1, ...},//第一个一级下的二级
	{"id":2,"pid":0, ...},//第二个一级
	{"id":4,"pid":2, ...},//第二个一级下的二级
]

父子级树状结构tree

[
	//第一个一级
	{"id":1,"pid":0, ... , "son":[ 
		//son字段下 是当前数据下的所有子级列表
		{"id":3,"pid":1, ... , "son":[]}
	] },
	//第二个一级
	{"id":2,"pid":0, ... , "son":[
		{"id":4,"pid":2, ..., "son":[]},
	]}
]

5.登录token认证

所有接口中，请求地址下方，若注明 “需进行token认证”，则需要在请求头信息中设置：
Authorization: 登录token值

其中，登录token值，由登录接口获取

接口目录

1.图片验证码接口

2.登录接口

3.退出接口

4.管理员 列表、详情、新增、修改、删除接口

5.角色 列表、详情、新增、修改、删除接口

6.权限 列表、详情、新增、修改、删除接口

7.菜单权限接口

8.商品分类 列表、详情、新增、修改、删除接口

9.logo图片上传接口

10.商品品牌 列表、详情、新增、修改、删除接口

11.商品模型 列表、详情、新增、修改、删除接口

12.多图上传接口

13.商品列表、详情、新增、修改、删除接口

14.商品修改页面 业务接口

15.相册图片删除接口

16.订单 列表、详情接口

一、登录相关

1.1、图片验证码接口

1、请求地址

GET /captcha

获取图片验证码图片地址

示例： http://adminapi.tbyue.com/captcha

2、请求参数

无

3、返回数据

返回数据

名称备注
url图片地址
uniqid验证码编号

4、返回示例

{
	"url":"http:\/\/adminapi.tbyue.com\/captcha\/captcha_5cf48283ef31d.html",
    "uniqid":"captcha_5cf48283ef31d"
}

1.2、登录接口

1、请求地址

POST /login

用于根据用户名、密码进行登录

示例： http://api.tbyue.com/login

2、请求参数

名称类型必填备注
usernamestring是用户名:admin
passwordstring是密码:123456
codestring是验证码
uniqidstring是验证码标识

3、返回数据

名称备注
tokentoken令牌
user_id用户id
username用户名
nickname用户昵称
email用户邮箱

4、返回示例

{
        "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImp0aSI6IjNmMmc1N2E5MmFhIn0.eyJpYXQiOjE1NTk1Mjk1MjksImlzcyI6Imh0dHA6XC9cL3d3dy5weWcuY29tIiwiYXVkIjoiaHR0cDpcL1wvd3d3LnB5Zy5jb20iLCJuYmYiOjE1NTk1Mjk1MjgsImV4cCI6MTU1OTUzMzEyOSwianRpIjoiM2YyZzU3YTkyYWEiLCJ1c2VyX2lkIjoxfQ.4BaThL6_TbIMBGLIWZgpnoDQ-JlAjzbiK3y3BcvNiGI",
        "user_id": 1,
        "username": "admin",
        "nickname": "admin",
        "email": "admin@itcast.cn"
    }

1.3、退出接口

1、请求地址

GET /logout

需进行token认证

示例： http://adminapi.tbyue.com/logout

2、请求参数

无

3、返回数据

无

4、返回示例

无

二、管理员

2.1、管理员列表

1、请求地址

GET /admins

需进行token认证

示例： http://adminapi.tbyue.com/admins

2、请求参数

名称类型必填备注
keywordstring否搜索关键字
pageint否页码，默认1

3、返回数据

名称备注
total总数量
per_page每页显示数
current_page当前页码
last_page总页数
data数据集

–其中：data数据集

名称备注
id用户id
username用户名
email邮箱
nickname昵称
last_login_time上次登录时间
status是否可用 1 可用；2 禁用
role_name所属角色名称

4、返回示例

{
        "total": 7,
        "per_page": 10,
        "current_page": 1,
        "last_page": 1,
        "data": [
            {
                "id": 1,
                "username": "admin",
                "email": "admin@itcast.cn",
                "nickname": "admin",
                "last_login_time": "2018-03-07 15:42:27",
                "status": 1,
                "role_name": "超级管理员"
            },
            {
                "id": 2,
                "username": "sunquan",
                "email": "sunquan@itcast.cn",
                "nickname": "骑鱼的猫",
                "last_login_time": "1970-01-01 08:00:00",
                "status": 1,
                "role_name": "主管"
            }
        ]
}

2.2、管理员详情

1、请求地址

GET /admins/[:id]

需进行token认证

[:id] 为管理员用户id

示例： http://adminapi.tbyue.com/admins/1

2、请求参数

无

3、返回数据

名称备注
id用户id
username用户名
email邮箱
nickname昵称
last_login_time上次登录时间
status是否可用 1 可用；2 禁用
role_id所属角色id

4、返回示例

{
        "id": 1,
        "username": "admin",
        "email": "admin@itcast.cn",
        "nickname": "admin",
        "last_login_time": "2018-03-07 15:42:27",
        "status": 1,
        "role_id": 1
    }

2.3、管理员新增

1、请求地址

POST /admins

需进行token认证

示例： http://adminapi.tbyue.com/admins

2、请求参数

名称类型必填备注
usernamestring是用户名
emailstring是邮箱
role_idstring是所属角色id
passwordstring否密码，初始密码123456

3、返回数据

名称备注
id用户id
username用户名
email邮箱
nickname昵称
last_login_time上次登录时间
status是否可用 1 可用；2 禁用
role_id所属角色id

4、返回示例

{
        "id": 1,
        "username": "admin",
        "email": "admin@itcast.cn",
        "nickname": "admin",
        "last_login_time": "2018-03-07 15:42:27",
        "status": 1,
        "role_id": 1
    }

2.4、管理员修改

1、请求地址

PUT /admins/[:id]

需进行token认证

[:id] 为管理员id

示例： http://adminapi.tbyue.com/admins/2

2、请求参数

重置密码：

名称类型必填备注
typestring是reset_pwd 重置密码

修改其他信息

名称类型必填备注
nicknamestring否昵称
emailstring否邮箱
role_idstring否所属角色id

3、返回数据

名称备注
id用户id
username用户名
email邮箱
nickname昵称
last_login_time上次登录时间
status是否可用 1 可用；2 禁用
role_id所属角色id

4、返回示例

	{
        "id": 1,
        "username": "admin",
        "email": "admin@itcast.cn",
        "nickname": "admin",
        "last_login_time": "2018-03-07 15:42:27",
        "status": 1,
        "role_id": 1
    }

2.5、管理员删除

1、请求地址

DELETE /admins/[:id]

需进行token认证

[:id] 为管理员id

示例： http://adminapi.tbyue.com/admins/2

2、请求参数

无

3、返回数据

无

4、返回示例

无

三、角色

3.1、角色列表

1、请求地址

GET /roles

需进行token认证

示例： http://adminapi.tbyue.com/roles

2、请求参数

无

3、返回数据

返回数据集[{},{},…]

名称备注
id角色id
role_name角色名称
desc描述
role_auths角色下的权限集合，父子级树状列表

4、返回示例

[
        {
            "id": 1,
            "role_name": "超级管理员",
            "desc": null,
            "role_auths":[
                {id: 1, auth_name: "首页", pid: 0, pid_path: "0", son: [...]},
                ...
            ]
        },
        {
            "id": 2,
            "role_name": "主管",
            "desc": null,
            "role_auths":[
                {id: 1, auth_name: "首页", pid: 0, pid_path: "0", son: [...]},
                ...
            ]
        },
]

3.2、角色详情

1、请求地址

GET /roles/[:id]

需进行token认证

[:id] 为角色id

示例： http://adminapi.tbyue.com/roles/1

2、请求参数

无

3、返回数据

名称备注
id角色id
role_name角色名称
desc描述
role_auth_ids拥有的权限ids

4、返回示例

{
    "id": 2,
    "role_name": "主管",
    "desc": null,
    "role_auth_ids":"1,2,3,4,5,8"
}

3.3、角色新增

1、请求地址

POST /roles

需进行token认证

示例： http://adminapi.tbyue.com/roles

2、请求参数

名称类型必填备注
role_namestring是角色名
descstring否描述
auth_idsstring是拥有的权限ids，示例：’1,3,4‘

3、返回数据

名称备注
id角色id
role_name角色名称
desc描述
role_auth_ids拥有的权限ids

4、返回示例

{
    "id": 2,
    "role_name": "主管",
    "desc": null,
    "role_auth_ids":"1,2,3,4,5,8"
}

3.4、角色修改

1、请求地址

PUT /roles/[:id]

需进行token认证

[:id] 为角色id

示例： http://adminapi.tbyue.com/roles/2

2、请求参数

名称类型必填备注
role_namestring是角色名
descstring否描述
auth_idsstring是拥有的权限ids，示例：’1,3,4‘

3、返回数据

名称备注
id角色id
role_name角色名称
desc描述
role_auth_ids拥有的权限ids

4、返回示例

{
    "id": 2,
    "role_name": "主管",
    "desc": null,
    "role_auth_ids":"1,2,3,4,5,8"
}

3.5、角色删除

1、请求地址

DELETE /roles/[:id]

需进行token认证

[:id] 为角色id

示例： http://adminapi.tbyue.com/roles/2

2、请求参数

无

3、返回数据

无

4、返回示例

无

四、权限

4.1、权限列表1

1、请求地址

GET /auths

需进行token认证

用于列表页、新增页、修改页展示，返回 无限级分类 列表结构数据

示例： http://adminapi.tbyue.com/auths

2、请求参数

无

3、返回数据

返回数据集[{},{},…]

名称备注
id权限id
auth_name权限名称
pid父id
pid_path家族图谱（祖先id_父id）,示例：0_1_2
auth_c控制器名称
auth_a方法名称
is_nav是否菜单权限 1是 0否
level级别 0 1 2 3 ， 0为最顶级

4、返回示例

[
        {
            "id": 10,
            "auth_name": "菜单管理",
            "pid": 5,
            "pid_path": "0_2_5",
            "auth_c": "auth",
            "auth_a": "index",
            "is_nav": "1",
            "level": 2
        },
        {
            "id": 65,
            "auth_name": "添加权限",
            "pid": 10,
            "pid_path": "0_2_5_10",
            "auth_c": "auth",
            "auth_a": "create",
            "is_nav": "0",
            "level": 3
        }
]

4.2、权限列表2

1、请求地址

GET /auths

需进行token认证

用于给角色分配权限，返回 父子级 树状结构数据

示例： http://adminapi.tbyue.com/auths

2、请求参数

名称类型必填备注
typestring是tree

3、返回数据

返回数据集[{},{},…]

树状结构，每个权限中有son字段，包含其所有子权限

名称备注
id权限id
auth_name权限名称
pid父id
pid_path家族图谱（祖先id_父id）,示例：0_1_2
auth_c控制器名称
auth_a方法名称
is_nav是否菜单权限 1是 0否
level级别 0 1 2 3 ， 0为最顶级
son子权限数据集

4、返回示例

[
        {
            "id": 1,
            "auth_name": "首页",
            "pid": 0,
            "pid_path": "0",
            "auth_c": "",
            "auth_a": "",
            "is_nav": "是",
            "level": 0,
            "son": [
                {
                    "id": 90,
                    "auth_name": "首页",
                    "pid": 1,
                    "pid_path": "0_1",
                    "auth_c": "",
                    "auth_a": "",
                    "is_nav": "是",
                    "level": 1,
                    "son": [
                        {
                            "id": 91,
                            "auth_name": "首页",
                            "pid": 90,
                            "pid_path": "0_1_90",
                            "auth_c": "index",
                            "auth_a": "index",
                            "is_nav": "是",
                            "level": 2,
                            "son": []
                        }
                    ]
                }
            ]
        },
        {
            "id": 2,
            "auth_name": "平台",
            "pid": 0,
            "pid_path": "0",
            "auth_c": "",
            "auth_a": "",
            "is_nav": "是",
            "level": 0,
            "son": [
                {
                    "id": 5,
                    "auth_name": "系统配置",
                    "pid": 2,
                    "pid_path": "0_2",
                    "auth_c": "",
                    "auth_a": "",
                    "is_nav": "是",
                    "level": 1,
                    "son": [
                        {
                            "id": 9,
                            "auth_name": "附件管理",
                            "pid": 5,
                            "pid_path": "0_2_5",
                            "auth_c": "",
                            "auth_a": "",
                            "is_nav": "是",
                            "level": 2,
                            "son": []
                        },
                        {
                            "id": 10,
                            "auth_name": "菜单管理",
                            "pid": 5,
                            "pid_path": "0_2_5",
                            "auth_c": "auth",
                            "auth_a": "index",
                            "is_nav": "是",
                            "level": 2,
                            "son": []
                        }
                    ]
                },
                {
                    "id": 6,
                    "auth_name": "权限管理",
                    "pid": 2,
                    "pid_path": "0_2",
                    "auth_c": "",
                    "auth_a": "",
                    "is_nav": "是",
                    "level": 1,
                    "son": [
                        {
                            "id": 11,
                            "auth_name": "管理员管理",
                            "pid": 6,
                            "pid_path": "0_2_6",
                            "auth_c": "admin",
                            "auth_a": "index",
                            "is_nav": "是",
                            "level": 2,
                            "son": []
                        },
                        {
                            "id": 12,
                            "auth_name": "角色管理",
                            "pid": 6,
                            "pid_path": "0_2_6",
                            "auth_c": "role",
                            "auth_a": "index",
                            "is_nav": "是",
                            "level": 2,
                            "son": []
                        }
                    ]
                }
            ]
        },
]

4.3、权限详情

1、请求地址

GET /auths/[:id]

需进行token认证

[:id] 为权限id

示例： http://adminapi.tbyue.com/auths/1

2、请求参数

无

3、返回数据

名称备注
id权限id
auth_name权限名称
pid父id
pid_path家族图谱（祖先id_父id）,示例：0_1_2
auth_c控制器名称
auth_a方法名称
is_nav是否菜单权限 1是 0否
level级别 0 1 2 3 ， 0为最顶级

4、返回示例

{
    "id": 65,
    "auth_name": "添加权限",
    "pid": 10,
    "pid_path": "0_2_5_10",
    "auth_c": "auth",
    "auth_a": "create",
    "is_nav": 0,
    "level": 3
}

4.4、权限新增

1、请求地址

POST /auths

需进行token认证

示例： http://adminapi.tbyue.com/auths

2、请求参数

名称类型必填备注
auth_namestring是权限名
pidint是父级权限id
auth_cstring否控制器名
auth_astring否方法名
is_navint是是否菜单权限 1是 0否

3、返回数据

名称备注
id权限id
auth_name权限名称
pid父id
pid_path家族图谱（祖先id_父id）,示例：0_1_2
auth_c控制器名称
auth_a方法名称
is_nav是否菜单权限 1是 0否
level级别 0 1 2 3 ， 0为最顶级

4、返回示例

{
    "id": 65,
    "auth_name": "添加权限",
    "pid": 10,
    "pid_path": "0_2_5_10",
    "auth_c": "auth",
    "auth_a": "create",
    "is_nav": 0,
    "level": 3
}

4.5、权限修改

1、请求地址

PUT /auths/[:id]

需进行token认证

[:id] 为权限id

示例： http://adminapi.tbyue.com/auths/2

2、请求参数

名称类型必填备注
auth_namestring是权限名
pidint是父级权限id
auth_cstring否控制器名
auth_astring否方法名
is_navint是是否菜单权限 1是 0否

3、返回数据

名称备注
id权限id
auth_name权限名称
pid父id
pid_path家族图谱（祖先id_父id）,示例：0_1_2
auth_c控制器名称
auth_a方法名称
is_nav是否菜单权限 1是 0否
level级别 0 1 2 3 ， 0为最顶级

4、返回示例

{
    "id": 65,
    "auth_name": "添加权限",
    "pid": 10,
    "pid_path": "0_2_5_10",
    "auth_c": "auth",
    "auth_a": "create",
    "is_nav": 0,
    "level": 3
}

4.6、权限删除

1、请求地址

DELETE /auths/[:id]

需进行token认证

[:id] 为权限id

示例： http://adminapi.tbyue.com/auths/2

2、请求参数

无

3、返回数据

无

4、返回示例

无

4.7 获取菜单权限

1、请求地址

GET /nav

需进行token认证

示例： http://adminapi.tbyue.com/nav

2、请求参数

无

3、返回数据

返回父子级树状结构 数据集[{},{},…]

名称备注
id权限id
auth_name权限名称
pid父id
pid_path家族图谱（祖先id_父id）,示例：0_1_2
auth_c控制器名称
auth_a方法名称
is_nav是否菜单权限 1是 0否
level级别 0 1 2 3 ， 0为最顶级
son子权限数据集

4、返回示例

[
        {
            "id": 1,
            "auth_name": "首页",
            "pid": 0,
            "pid_path": "0",
            "auth_c": "",
            "auth_a": "",
            "is_nav": "是",
            "level": 0,
            "son": [
                {
                    "id": 90,
                    "auth_name": "首页",
                    "pid": 1,
                    "pid_path": "0_1",
                    "auth_c": "",
                    "auth_a": "",
                    "is_nav": "是",
                    "level": 1,
                    "son": [
                        {
                            "id": 91,
                            "auth_name": "首页",
                            "pid": 90,
                            "pid_path": "0_1_90",
                            "auth_c": "index",
                            "auth_a": "index",
                            "is_nav": "是",
                            "level": 2,
                            "son": []
                        }
                    ]
                }
            ]
        },
        {
            "id": 2,
            "auth_name": "平台",
            "pid": 0,
            "pid_path": "0",
            "auth_c": "",
            "auth_a": "",
            "is_nav": "是",
            "level": 0,
            "son": [
                {
                    "id": 5,
                    "auth_name": "系统配置",
                    "pid": 2,
                    "pid_path": "0_2",
                    "auth_c": "",
                    "auth_a": "",
                    "is_nav": "是",
                    "level": 1,
                    "son": [
                        {
                            "id": 9,
                            "auth_name": "附件管理",
                            "pid": 5,
                            "pid_path": "0_2_5",
                            "auth_c": "",
                            "auth_a": "",
                            "is_nav": "是",
                            "level": 2,
                            "son": []
                        },
                        {
                            "id": 10,
                            "auth_name": "菜单管理",
                            "pid": 5,
                            "pid_path": "0_2_5",
                            "auth_c": "auth",
                            "auth_a": "index",
                            "is_nav": "是",
                            "level": 2,
                            "son": []
                        }
                    ]
                },
                {
                    "id": 6,
                    "auth_name": "权限管理",
                    "pid": 2,
                    "pid_path": "0_2",
                    "auth_c": "",
                    "auth_a": "",
                    "is_nav": "是",
                    "level": 1,
                    "son": [
                        {
                            "id": 11,
                            "auth_name": "管理员管理",
                            "pid": 6,
                            "pid_path": "0_2_6",
                            "auth_c": "admin",
                            "auth_a": "index",
                            "is_nav": "是",
                            "level": 2,
                            "son": []
                        },
                        {
                            "id": 12,
                            "auth_name": "角色管理",
                            "pid": 6,
                            "pid_path": "0_2_6",
                            "auth_c": "role",
                            "auth_a": "index",
                            "is_nav": "是",
                            "level": 2,
                            "son": []
                        }
                    ]
                }
            ]
        },
]

五、商品分类

5.1、分类列表1

1、请求地址

GET /categorys

需进行token认证

用于列表页、新增页、修改页展示，返回 无限级分类 列表结构数据

示例： http://adminapi.tbyue.com/categorys

2、请求参数

无

3、返回数据

返回数据集[{},{},…]

名称备注
id分类id
cate_name分类名称
pid父id
pid_path_name家族图谱名称(祖先名/父级名)
level级别 0 1 2 ， 0为最顶级
is_show是否显示
is_hot是否热门
image_url分类logo图片

4、返回示例

[
        {
            "id": 1,
            "cate_name": "家用电器",
            "pid": 0,
            "pid_path_name": "",
            "level": 0,
            "is_show": "是",
            "image_url": "",
            "is_hot": "否"
        },
        {
            "id": 16,
            "cate_name": "电视",
            "pid": 1,
            "pid_path_name": "家用电器",
            "level": 1,
            "is_show": "是",
            "image_url": "",
            "is_hot": "否"
        }
]

5.2、分类列表2

1、请求地址

GET /categorys

需进行token认证

用于三级联动 获取子分类

示例： http://adminapi.tbyue.com/categorys

2、请求参数

名称类型必填备注
pidint是顶级：0，子级：父级id
typestring是“list”

3、返回数据

返回数据集[{},{},…]

名称备注
id分类id
cate_name分类名称
pid父id

4、返回示例

[
        {
            "id": 1,
            "cate_name": "家用电器",
            "pid": 0
        },
        {
            "id": 2,
            "cate_name": "手机/运营商/数码",
            "pid": 0
        }
]

5.3、分类详情

1、请求地址

GET /categorys/[:id]

需进行token认证

[:id] 为分类id

示例： http://adminapi.tbyue.com/categorys/1

2、请求参数

无

3、返回数据

名称备注
id分类id
cate_name分类名称
pid父id
pid_path_name家族图谱名称(祖先名/父级名)
level级别 0 1 2 ， 0为最顶级
is_show是否显示
is_hot是否热门
image_url分类logo图片

4、返回示例

{
    "id": 1,
    "cate_name": "家用电器",
    "pid": 0,
    "pid_path_name": "",
    "level": 0,
    "is_show": "是",
    "image_url": "",
    "is_hot": "否"
}

5.4、分类新增

1、请求地址

POST /categorys

需进行token认证

示例： http://adminapi.tbyue.com/categorys

2、请求参数

名称类型必填备注
cate_namestring是分类名
pidint是父级id
is_showint是是否显示 1是 0否
is_hotint是是否热门 1是 0否
sortint是排序
logostring否logo图片地址

3、返回数据

名称备注
id分类id
cate_name分类名称
pid父id
pid_path_name家族图谱名称(祖先名/父级名)
level级别 0 1 2 ， 0为最顶级
is_show是否显示
is_hot是否热门
image_url分类logo图片

4、返回示例

{
    "id": 1,
    "cate_name": "家用电器",
    "pid": 0,
    "pid_path_name": "",
    "level": 0,
    "is_show": "是",
    "image_url": "",
    "is_hot": "否"
}

5.5、分类修改

1、请求地址

PUT /categorys/[:id]

需进行token认证

[:id] 为分类id

示例： http://adminapi.tbyue.com/categorys/2

2、请求参数

名称类型必填备注
cate_namestring是分类名
pidint是父级id
is_showint是是否显示 1是 0否
is_hotint是是否热门 1是 0否
sortint是排序
logostring否logo图片地址

3、返回数据

名称备注
id分类id
cate_name分类名称
pid父id
pid_path_name家族图谱名称(祖先名/父级名)
level级别 0 1 2 ， 0为最顶级
is_show是否显示
is_hot是否热门
image_url分类logo图片

4、返回示例

{
    "id": 1,
    "cate_name": "家用电器",
    "pid": 0,
    "pid_path_name": "",
    "level": 0,
    "is_show": "是",
    "image_url": "",
    "is_hot": "否"
}

5.6、分类删除

1、请求地址

DELETE /categorys/[:id]

需进行token认证

[:id] 为分类id

示例： http://adminapi.tbyue.com/categorys/2

2、请求参数

无

3、返回数据

无

4、返回示例

无

六、商品品牌

6.1、品牌列表

1、请求地址

GET /brands

需进行token认证

示例： http://adminapi.tbyue.com/brands

2、请求参数

名称类型必填备注
keywordstring否搜索关键字，按品牌名称搜索
pageint否页码，默认1

3、返回数据

名称备注
total总数量
per_page每页显示数
current_page当前页码
last_page总页数
data数据集

–其中：data数据集

名称备注
id品牌id
name品牌名
logo品牌logo
desc品牌描述
sort排序
is_hot是否热门 1 是；0 否
cate_name所属分类名称

4、返回示例

{
        "total": 18,
        "per_page": 20,
        "current_page": 1,
        "last_page": 1,
        "data": [
            {
                "id": 1,
                "name": "华为（HUAWEI）",
                "logo": "/uploads/brand/0bedaba1e05119ac.jpg",
                "desc": "",
                "url": "",
                "sort": 50,
                "cate_id": 72,
                "is_hot": 1,
                "cate_name": "手机",
            },
            {
                "id": 2,
                "name": "小米（MI）",
                "logo": "/uploads/brand/600c61f344607414.jpg",
                "desc": "",
                "url": "",
                "sort": 50,
                "cate_id": 72,
                "is_hot": 1,
                "cate_name": "手机"
            }
        ]
}

6.2、品牌列表2

1、请求地址

GET /brands

需进行token认证

用于获取分类下的品牌（比如商品添加页面选择品牌）

示例： http://adminapi.tbyue.com/brands

2、请求参数

名称类型必填备注
cate_idint是分类id: 72

3、返回数据

返回数据集[{},{},…]

名称备注
id品牌id
name品牌名称

4、返回示例

[
        {
            "id": 1,
            "name": "华为（HUAWEI）",
        },
        {
            "id": 2,
            "name": "小米（MI）"
        }
]

6.3、品牌详情

1、请求地址

GET /brands/[:id]

需进行token认证

[:id] 为品牌id

示例： http://adminapi.tbyue.com/brands/1

2、请求参数

无

3、返回数据

名称备注
id品牌id
name品牌名
logo品牌logo
desc品牌描述
sort排序
is_hot是否热门 1 是；0 否
cate_id所属分类id
url品牌地址

4、返回示例

{
        "id": 1,
        "name": "华为（HUAWEI）",
        "logo": "/uploads/brand/0bedaba1e05119ac.jpg",
        "desc": "",
        "url": "",
        "sort": 50,
        "cate_id": 72,
        "is_hot": 1
}

6.4、品牌新增

1、请求地址

POST /brands

需进行token认证

示例： http://adminapi.tbyue.com/brands

2、请求参数

名称类型必填备注
namestring是品牌名
cate_idint是所属分类id
descint否描述
is_hotint是是否热门 1是 0否
sortint是排序
logostring否logo图片地址
urlstring否品牌地址

3、返回数据

名称备注
id品牌id
name品牌名
logo品牌logo
desc品牌描述
sort排序
is_hot是否热门 1 是；0 否
cate_id所属分类id
url品牌地址

4、返回示例

{
        "id": 1,
        "name": "华为（HUAWEI）",
        "logo": "/uploads/brand/0bedaba1e05119ac.jpg",
        "desc": "",
        "url": "",
        "sort": 50,
        "cate_id": 72,
        "is_hot": 1
}

6.5、品牌修改

1、请求地址

PUT /brands/[:id]

需进行token认证

[:id] 为品牌id

示例： http://adminapi.tbyue.com/brands/2

2、请求参数

名称类型必填备注
namestring是品牌名
cate_idint是所属分类id
descint否描述
is_hotint是是否热门 1是 0否
sortint是排序
logostring否logo图片地址
urlstring否品牌地址

3、返回数据

名称备注
id品牌id
name品牌名
logo品牌logo
desc品牌描述
sort排序
is_hot是否热门 1 是；0 否
cate_id所属分类id
url品牌地址

4、返回示例

{
        "id": 1,
        "name": "华为（HUAWEI）",
        "logo": "/uploads/brand/0bedaba1e05119ac.jpg",
        "desc": "",
        "url": "",
        "sort": 50,
        "cate_id": 72,
        "is_hot": 1
}

6.6、品牌删除

1、请求地址

DELETE /brands/[:id]

需进行token认证

[:id] 为品牌id

示例： http://adminapi.tbyue.com/brands/2

2、请求参数

无

3、返回数据

无

4、返回示例

无

七、文件上传

7.1、单图片上传

1、请求地址

POST /logo

需进行token认证

示例： http://adminapi.tbyue.com/logo

2、请求参数

名称类型必填备注
typestring是图片类型。商品：goods；分类：category；品牌：brand
logofile是logo文件

3、返回数据

logo文件访问路径

4、返回示例

"/uploads/goods/20190530/adsdsfsgsds.png"

7.2、多图片上传

1、请求地址

POST /images

需进行token认证

示例： http://adminapi.tbyue.com/images

2、请求参数

名称类型必填备注
typestring否图片类型。默认为商品：goods
imagesarray是文件数组

3、返回数据

名称备注
success上传成功的图片地址集合
error上传失败的图片名称和错误信息集合

4、返回示例

{
	“success”:[
		"/uploads/goods/20190530/dsgdsafdsfds.png",
		"/uploads/goods/20190530/dsfdsdgfdasd.png",
	],
	"error":[
		{
			"name":"1.png",
			"msg":"图片尺寸错误"
		},
		{
			"name":"2.png",
			"msg":"图片类型错误"
		}
	]
}

八、商品模型

8.1、模型列表

1、请求地址

GET /types

需进行token认证

示例： http://adminapi.tbyue.com/types

2、请求参数

无

3、返回数据

返回数据集[{},{}]

名称备注
id模型id
type_name模型名

4、返回示例

[
		{
            "id": 16,
            "type_name": "手机"
        },
        {
            "id": 17,
            "type_name": "坚果"
        }
]

8.2、模型详情

1、请求地址

GET /types/[:id]

需进行token认证

[:id] 为模型id

示例： http://adminapi.tbyue.com/types/16

2、请求参数

无

3、返回数据

名称备注
id模型id
type_name模型名
specs规格数据集
attrs属性数据集

–specs规格数据集

名称备注
id规格id
type_id所属模型id
spec_name规格名称
sort排序
spec_values规格值数据集

----specs.spec_values规格值数据集

名称备注
id规格值id
spec_id所属规格id
spec_value规格值
type_id所属模型id

–attrs属性数据集

名称备注
id属性id
attr_name属性名称
type_id所属模型id
attr_values可选值数组（可能为空）
sort排序

4、返回示例

{
        "id": 16,
        "type_name": "手机",
        "specs": [
            {
                "id": 19,
                "type_id": 16,
                "spec_name": "颜色",
                "sort": 0,
                "spec_values": [
                    {
                        "id": 18,
                        "spec_id": 19,
                        "spec_value": "黑色",
                        "type_id": 16
                    },
                    {
                        "id": 19,
                        "spec_id": 19,
                        "spec_value": "白色",
                        "type_id": 16
                    },
                    {
                        "id": 20,
                        "spec_id": 19,
                        "spec_value": "红色",
                        "type_id": 16
                    }
                ]
            },
            {
                "id": 20,
                "type_id": 16,
                "spec_name": "版本",
                "sort": 0,
                "spec_values": [
                    {
                        "id": 21,
                        "spec_id": 20,
                        "spec_value": "全网通（4G+64G）",
                        "type_id": 16
                    },
                    {
                        "id": 22,
                        "spec_id": 20,
                        "spec_value": "全网通（6G+64G）",
                        "type_id": 16
                    }
                ]
            }
        ],
        "attrs": [
            {
                "id": 7,
                "attr_name": "毛重",
                "type_id": 16,
                "attr_values": [],
                "sort": 0
            },
            {
                "id": 8,
                "attr_name": "产地",
                "type_id": 16,
                "attr_values": [],
                "sort": 0
            }
        ]
}

8.3、模型新增

1、请求地址

POST /types

需进行token认证

示例： http://adminapi.tbyue.com/types

2、请求参数

名称类型必填备注
type_namestring是模型名
specint是规格数组
attrint是属性数组

参数示例：

type_name: 手机
spec[0][name]: 颜色
spec[0][sort]: 50
spec[0][value][]: 白色
spec[0][value][]: 黑色
spec[1][name]: 内存
spec[1][sort]: 50
spec[1][value][]: 64G
spec[1][value][]: 128G
attr[0][name]: 毛重
attr[0][sort]: 50
attr[0][value][]: 
attr[1][name]: 产地
attr[1][sort]: 50
attr[1][value][]: 进口
attr[1][value][]: 国产

3、返回数据

名称备注
id模型id
type_name模型名

4、返回示例

{
    "id": 16,
    "type_name": "手机"
}

8.4、模型修改

1、请求地址

PUT /types/[:id]

需进行token认证

[:id] 为模型id

示例： http://adminapi.tbyue.com/types/16

2、请求参数

名称类型必填备注
type_namestring是模型名
specint是规格数组
attrint是属性数组

参数示例：

type_name: 手机
spec[0][name]: 颜色
spec[0][sort]: 50
spec[0][value][]: 白色
spec[0][value][]: 黑色
spec[1][name]: 内存
spec[1][sort]: 50
spec[1][value][]: 64G
spec[1][value][]: 128G
attr[0][name]: 毛重
attr[0][sort]: 50
attr[0][value][]: 
attr[1][name]: 产地
attr[1][sort]: 50
attr[1][value][]: 进口
attr[1][value][]: 国产

3、返回数据

名称备注
id模型id
type_name模型名

4、返回示例

{
    "id": 16,
    "type_name": "手机"
}

8.5、模型删除

1、请求地址

DELETE /types/[:id]

需进行token认证

[:id] 为模型id

示例： http://adminapi.tbyue.com/types/17

2、请求参数

无

3、返回数据

无

4、返回示例

无

九、商品

9.1、商品列表

1、请求地址

GET /goods

需进行token认证

示例： http://adminapi.tbyue.com/goods

2、请求参数

名称类型必填备注
keywordstring否搜索关键字
pageint否页码，默认1

3、返回数据

名称备注
total总数量
per_page每页显示数
current_page当前页码
last_page总页数
data数据集

–其中：data数据集

名称备注
id商品id
goods_name商品名
goods_logo商品logo
goods_price商品价格
goods_number总库存
is_hot是否热卖 1 是；0 否
is_on_sale是否上架 1 是；0 否
is_free_shipping是否包邮 1 是；0 否
is_recommend是否推荐 1 是；0 否
is_new是否新品 1 是；0 否
sales_num销量
sort排序
market_price市场价
cost_price成本价
goods_remark商品简介
goods_desc商品详情
weight商品重量
volume商品体积
keywords商品关键字
comments_num评论数
collect_num收藏数
mould_id运费模板id
type_name所属模型名
brand_name所属品牌名
cate_name所属分类名
goods_attr商品属性值集合

4、返回示例

{
        "total": 61,
        "per_page": 2,
        "current_page": 1,
        "last_page": 31,
        "data": [
            {
                "id": 61,
                "goods_name": "iphone xr 没朋友啊",
                "goods_price": "1000.00",
                "market_price": "0.00",
                "cost_price": "0.00",
                "goods_number": 100,
                "frozen_number": 0,
                "goods_remark": "11111111",
                "goods_desc": "<p>test</p>",
                "goods_logo": "/uploads/goods/20190528/a3fe2eccd3a90a71.jpg",
                "type_id": 16,
                "brand_id": 3,
                "cate_id": 72,
                "mould_id": 0,
                "weight": 0,
                "volume": 0,
                "keywords": "",
                "comments_num": 0,
                "collect_num": "0",
                "sales_num": 0,
                "is_on_sale": 1,
                "is_free_shipping": 1,
                "is_recommend": 1,
                "is_new": 1,
                "is_hot": 1,
                "sort": 50,
                "suppliers_id": 0,
                "goods_attr": [
                    {
                        "id": "7",
                        "attr_name": "毛重",
                        "attr_value": "180g"
                    },
                    {
                        "id": "8",
                        "attr_name": "产地",
                        "attr_value": "中国"
                    }
                ],
                "cate_name": "手机",
                "type_name": "手机",
                "brand_name": "Apple"
            },
            {
                "id": 60,
                "goods_name": "vivo U1 水滴全面屏 AI智慧拍照手机 3GB+32GB 极光色 移动联通电信全网通4G手机",
                "goods_price": "4099.00",
                "market_price": "4099.00",
                "cost_price": "4099.00",
                "goods_number": 100,
                "frozen_number": 0,
                "goods_remark": "",
                "goods_desc": null,
                "goods_logo": "/uploads/goods/20190528/3ec982e47f5256f1.jpg",
                "type_id": 0,
                "brand_id": 8,
                "cate_id": 72,
                "mould_id": 0,
                "weight": null,
                "volume": null,
                "keywords": "",
                "comments_num": 0,
                "collect_num": "0",
                "sales_num": 0,
                "is_on_sale": 1,
                "is_free_shipping": 1,
                "is_recommend": 1,
                "is_new": 1,
                "is_hot": 1,
                "sort": 50,
                "suppliers_id": 0,
                "goods_attr": [
                    {
                        "id": "7",
                        "attr_name": "毛重",
                        "attr_value": "180g"
                    },
                    {
                        "id": "8",
                        "attr_name": "产地",
                        "attr_value": "中国"
                    }
                ],
                "cate_name": "手机",
                "type_name": null,
                "brand_name": "vivo"
            }
        ]

}

9.2、商品详情

1、请求地址

GET /goods/[:id]

需进行token认证

[:id] 为商品id

示例： http://adminapi.tbyue.com/goods/16

2、请求参数

无

3、返回数据

名称备注
id商品id
goods_name商品名
goods_logo商品logo
goods_price商品价格
goods_number总库存
is_hot是否热卖 1 是；0 否
is_on_sale是否上架 1 是；0 否
is_free_shipping是否包邮 1 是；0 否
is_recommend是否推荐 1 是；0 否
is_new是否新品 1 是；0 否
sales_num销量
sort排序
market_price市场价
cost_price成本价
goods_remark商品简介
goods_desc商品详情
weight商品重量
volume商品体积
keywords商品关键字
comments_num评论数
collect_num收藏数
mould_id运费模板id
goods_attr商品属性值集合
category所属分类信息对象
type所属模型信息对象
goods_images相册图片集合
spec_goods规格商品集合（SKU）

–category对象

名称备注
id分类id
cate_name分类名称
pid_path_name家族图谱名称

–goods_images集合

名称备注
id相册图片id
goods_id商品id
pics_big大图地址
pics_sma小图地址

–spec_goods集合

名称备注
id规格商品id
goods_id商品id
value_ids规格值ids
value_names规格值名
price商品价格
cost_price成本价格
store_count库存
store_frozen冻结库存

–type对象

名称备注
id模型id
type_name模型名称
attrs属性信息集合
specs规格信息集合

–type–attrs集合

名称备注
id属性id
attr_name属性名称
type_id所属模型id
attr_values属性可选值数组
sort排序

–type–specs集合

名称备注
id规格id
spec_name规格名称
type_id所属模型id
sort排序
spec_values规格值集合

–type–specs–spec_values集合

名称备注
id规格值id
spec_id所属规格id
spec_value规格值
type_id所属模型id

4、返回示例

{
    "code": 200,
    "msg": "success",
    "data": {
        "id": 61,
        "goods_name": "iphone xr 没朋友啊",
        "goods_price": "1000.00",
        "market_price": "0.00",
        "cost_price": "0.00",
        "goods_number": 100,
        "frozen_number": 0,
        "goods_remark": "11111111",
        "goods_desc": "<p>test</p>",
        "goods_logo": "/uploads/goods/20190528/a3fe2eccd3a90a71.jpg",
        "type_id": 16,
        "brand_id": 3,
        "cate_id": 72,
        "mould_id": 0,
        "weight": 0,
        "volume": 0,
        "keywords": "",
        "comments_num": 0,
        "collect_num": "0",
        "sales_num": 0,
        "is_on_sale": 1,
        "is_free_shipping": 1,
        "is_recommend": 1,
        "is_new": 1,
        "is_hot": 1,
        "sort": 50,
        "suppliers_id": 0,
        "goods_attr": [
            {
                "id": "7",
                "attr_name": "毛重",
                "attr_value": "180g"
            },
            {
                "id": "8",
                "attr_name": "产地",
                "attr_value": "中国"
            }
        ],
        "category": {
            "id": 72,
            "cate_name": "手机",
            "pid": 71,
            "pid_path": [
                "0",
                "2",
                "71"
            ],
            "pid_path_name": "手机/运营商/数码_手机通讯",
            "level": 2,
            "sort": 50,
            "is_show": "是",
            "image_url": "",
            "is_hot": "否"
        },
        "brand": {
            "id": 3,
            "name": "Apple",
            "logo": "/uploads/brand/574d36dbN262ef26d.jpg",
            "desc": "",
            "url": "",
            "sort": 50,
            "cate_id": 72,
            "is_hot": 1
        },
        "type": {
            "id": 16,
            "type_name": "手机",
            "attrs": [
                {
                    "id": 7,
                    "attr_name": "毛重",
                    "type_id": 16,
                    "attr_values": [],
                    "sort": 0
                },
                {
                    "id": 8,
                    "attr_name": "产地",
                    "type_id": 16,
                    "attr_values": [],
                    "sort": 0
                }
            ],
            "specs": [
                {
                    "id": 19,
                    "type_id": 16,
                    "spec_name": "颜色",
                    "sort": 0,
                    "spec_values": [
                        {
                            "id": 18,
                            "spec_id": 19,
                            "spec_value": "黑色",
                            "type_id": 16
                        },
                        {
                            "id": 19,
                            "spec_id": 19,
                            "spec_value": "白色",
                            "type_id": 16
                        },
                        {
                            "id": 20,
                            "spec_id": 19,
                            "spec_value": "红色",
                            "type_id": 16
                        }
                    ]
                },
                {
                    "id": 20,
                    "type_id": 16,
                    "spec_name": "版本",
                    "sort": 0,
                    "spec_values": [
                        {
                            "id": 21,
                            "spec_id": 20,
                            "spec_value": "全网通（4G+64G）",
                            "type_id": 16
                        },
                        {
                            "id": 22,
                            "spec_id": 20,
                            "spec_value": "全网通（6G+64G）",
                            "type_id": 16
                        }
                    ]
                }
            ]
        },
        "goods_images": [],
        "spec_goods": [
            {
                "id": 801,
                "goods_id": 61,
                "value_ids": "18_21",
                "value_names": "颜色:黑色 版本:全网通（4G+64G）",
                "price": "1000.00",
                "cost_price": "1000.00",
                "store_count": 100,
                "store_frozen": 0
            },
            {
                "id": 802,
                "goods_id": 61,
                "value_ids": "18_22",
                "value_names": "颜色:黑色 版本:全网通（6G+64G）",
                "price": "1100.00",
                "cost_price": "1000.00",
                "store_count": 100,
                "store_frozen": 0
            },
            {
                "id": 803,
                "goods_id": 61,
                "value_ids": "19_21",
                "value_names": "颜色:白色 版本:全网通（4G+64G）",
                "price": "1200.00",
                "cost_price": "1100.00",
                "store_count": 100,
                "store_frozen": 0
            },
            {
                "id": 804,
                "goods_id": 61,
                "value_ids": "19_22",
                "value_names": "颜色:白色 版本:全网通（6G+64G）",
                "price": "1200.00",
                "cost_price": "1100.00",
                "store_count": 96,
                "store_frozen": 4
            }
        ]
    }
}

9.3、商品新增

1、请求地址

POST /goods

需进行token认证

示例： http://adminapi.tbyue.com/goods

2、请求参数

名称类型必填备注
goods_namestring是商品名
goods_remarkstring是商品简介
cate_idint是商品分类id
brand_idint是商品品牌id
goods_pricestring是商品价格
market_pricestring是市场价格
cost_pricestring是成本价格
goods_logostring是商品logo
is_free_shippingint是是否包邮 1 是；0 否
mould_idint否运费模板id
weightstring否商品重量
volumestring否商品体积
goods_numberstring否总库存
keywordsstring否商品关键字
goods_descstring否商品详情
is_hotint否是否热卖 1 是；0 否
is_on_saleint否是否上架 1 是；0 否
is_recommendint否是否推荐 1 是；0 否
is_newint否是否新品 1 是；0 否
sortint否排序
goods_imagesarray是相册图片集合
type_idint是商品模型id
itemarray是商品规格值集合
attrarray是商品属性值集合

规格值和属性值参数示例：

item[规格id1_规格id2]

attr[属性id]


item[18_21][price]: 0
item[18_21][value_names]: 颜色:黑色 版本:全网通（4G+64G）
item[18_21][value_ids]: 18_21
item[18_21][cost_price]: 0
item[18_21][store_count]: 0
item[18_22][price]: 0
item[18_22][value_names]: 颜色:黑色 版本:全网通（6G+64G）
item[18_22][value_ids]: 18_22
item[18_22][cost_price]: 0
item[18_22][store_count]: 0
item[19_21][price]: 0
item[19_21][value_names]: 颜色:白色 版本:全网通（4G+64G）
item[19_21][value_ids]: 19_21
item[19_21][cost_price]: 0
item[19_21][store_count]: 0
item[19_22][price]: 0
item[19_22][value_names]: 颜色:白色 版本:全网通（6G+64G）
item[19_22][value_ids]: 19_22
item[19_22][cost_price]: 0
item[19_22][store_count]: 0
attr[7][attr_name]: 毛重
attr[7][id]: 7
attr[7][attr_value]: 100g
attr[8][attr_name]: 产地
attr[8][id]: 8
attr[8][attr_value]: 中国

3、返回数据

名称备注
id商品id
goods_name商品名
goods_logo商品logo
goods_price商品价格
goods_number总库存
is_hot是否热卖 1 是；0 否
is_on_sale是否上架 1 是；0 否
is_free_shipping是否包邮 1 是；0 否
is_recommend是否推荐 1 是；0 否
is_new是否新品 1 是；0 否
sales_num销量
sort排序
market_price市场价
cost_price成本价
goods_remark商品简介
goods_desc商品详情
weight商品重量
volume商品体积
keywords商品关键字
comments_num评论数
collect_num收藏数
mould_id运费模板id
type_name所属模型名
brand_name所属品牌名
cate_name所属分类名
goods_attr商品属性值集合

4、返回示例

{
                "id": 61,
                "goods_name": "iphone xr 没朋友啊",
                "goods_price": "1000.00",
                "market_price": "0.00",
                "cost_price": "0.00",
                "goods_number": 100,
                "frozen_number": 0,
                "goods_remark": "11111111",
                "goods_desc": "<p>test</p>",
                "goods_logo": "/uploads/goods/20190528/a3fe2eccd3a90a71.jpg",
                "type_id": 16,
                "brand_id": 3,
                "cate_id": 72,
                "mould_id": 0,
                "weight": 0,
                "volume": 0,
                "keywords": "",
                "comments_num": 0,
                "collect_num": "0",
                "sales_num": 0,
                "is_on_sale": 1,
                "is_free_shipping": 1,
                "is_recommend": 1,
                "is_new": 1,
                "is_hot": 1,
                "sort": 50,
                "suppliers_id": 0,
                "goods_attr": [
                    {
                        "id": "7",
                        "attr_name": "毛重",
                        "attr_value": "180g"
                    },
                    {
                        "id": "8",
                        "attr_name": "产地",
                        "attr_value": "中国"
                    }
                ],
                "cate_name": "手机",
                "type_name": "手机",
                "brand_name": "Apple"
    }

9.4、商品修改页面接口

1、请求地址

GET /goods/[:id]/edit

需进行token认证

[:id] 为模型id

示例： http://adminapi.tbyue.com/goods/61/edit

2、请求参数

无

3、返回数据

返回数据对象{}

名称备注
goods商品信息对象
category分类信息集合
type模型信息集合

–category数据集合

名称备注
cate_one所有一级分类数据集合
cate_two商品所属一级分类下的二级分类数据集合
cate_three商品所属二级分类下的三级分类数据集合

分类集合：

名称备注
id分类id
cate_name分类名称

–type数据集合

名称备注
id模型id
type_name模型名称

–goods数据对象

名称备注
id商品id
goods_name商品名
goods_logo商品logo
goods_price商品价格
goods_number总库存
is_hot是否热卖 1 是；0 否
is_on_sale是否上架 1 是；0 否
is_free_shipping是否包邮 1 是；0 否
is_recommend是否推荐 1 是；0 否
is_new是否新品 1 是；0 否
sales_num销量
sort排序
market_price市场价
cost_price成本价
goods_remark商品简介
goods_desc商品详情
weight商品重量
volume商品体积
keywords商品关键字
comments_num评论数
collect_num收藏数
mould_id运费模板id
goods_attr商品属性值集合
category所属分类信息对象
type所属模型信息对象
goods_images相册图片集合
spec_goods规格商品集合（SKU）

–goods–category对象

名称备注
id分类id
cate_name分类名称
pid_path家族图谱id
brands分类下的品牌

–goods–goods_images集合

名称备注
id相册图片id
goods_id商品id
pics_big大图地址
pics_sma小图地址

–goods–spec_goods集合

名称备注
id规格商品id
goods_id商品id
value_ids规格值ids
value_names规格值名
price商品价格
cost_price成本价格
store_count库存
store_frozen冻结库存

–goods–type对象

名称备注
id模型id
type_name模型名称
attrs属性信息集合
specs规格信息集合

–goods–type–attrs集合

名称备注
id属性id
attr_name属性名称
type_id所属模型id
attr_values属性可选值数组
sort排序

–goods–type–specs集合

名称备注
id规格id
spec_name规格名称
type_id所属模型id
sort排序
spec_values规格值集合

–goods–type–specs–spec_values集合

名称备注
id规格值id
spec_id所属规格id
spec_value规格值
type_id所属模型id

4、返回示例

{
                "id": 61,
                "goods_name": "iphone xr 没朋友啊",
                "goods_price": "1000.00",
                "market_price": "0.00",
                "cost_price": "0.00",
                "goods_number": 100,
                "frozen_number": 0,
                "goods_remark": "11111111",
                "goods_desc": "<p>test</p>",
                "goods_logo": "/uploads/goods/20190528/a3fe2eccd3a90a71.jpg",
                "type_id": 16,
                "brand_id": 3,
                "cate_id": 72,
                "mould_id": 0,
                "weight": 0,
                "volume": 0,
                "keywords": "",
                "comments_num": 0,
                "collect_num": "0",
                "sales_num": 0,
                "is_on_sale": 1,
                "is_free_shipping": 1,
                "is_recommend": 1,
                "is_new": 1,
                "is_hot": 1,
                "sort": 50,
                "suppliers_id": 0,
                "goods_attr": [
                    {
                        "id": "7",
                        "attr_name": "毛重",
                        "attr_value": "180g"
                    },
                    {
                        "id": "8",
                        "attr_name": "产地",
                        "attr_value": "中国"
                    }
                ],
                "cate_name": "手机",
                "type_name": "手机",
                "brand_name": "Apple"
    }

9.5、商品修改

1、请求地址

PUT /goods/[:id]

需进行token认证

[:id] 为模型id

示例： http://adminapi.tbyue.com/goods/61

2、请求参数

名称类型必填备注
goods_namestring是商品名
goods_remarkstring是商品简介
cate_idint是商品分类id
brand_idint是商品品牌id
goods_pricestring是商品价格
market_pricestring是市场价格
cost_pricestring是成本价格
goods_logostring是商品logo
is_free_shippingint是是否包邮 1 是；0 否
mould_idint否运费模板id
weightstring否商品重量
volumestring否商品体积
goods_numberstring否总库存
keywordsstring否商品关键字
goods_descstring否商品详情
is_hotint否是否热卖 1 是；0 否
is_on_saleint否是否上架 1 是；0 否
is_recommendint否是否推荐 1 是；0 否
is_newint否是否新品 1 是；0 否
sortint否排序
goods_imagesarray是相册图片集合
type_idint是商品模型id
itemarray是商品规格值集合
attrarray是商品属性值集合

规格值和属性值参数示例：

item[规格id1_规格id2]

attr[属性id]

item[18_21][price]: 0
item[18_21][value_names]: 颜色:黑色 版本:全网通（4G+64G）
item[18_21][value_ids]: 18_21
item[18_21][cost_price]: 0
item[18_21][store_count]: 0
item[18_22][price]: 0
item[18_22][value_names]: 颜色:黑色 版本:全网通（6G+64G）
item[18_22][value_ids]: 18_22
item[18_22][cost_price]: 0
item[18_22][store_count]: 0
item[19_21][price]: 0
item[19_21][value_names]: 颜色:白色 版本:全网通（4G+64G）
item[19_21][value_ids]: 19_21
item[19_21][cost_price]: 0
item[19_21][store_count]: 0
item[19_22][price]: 0
item[19_22][value_names]: 颜色:白色 版本:全网通（6G+64G）
item[19_22][value_ids]: 19_22
item[19_22][cost_price]: 0
item[19_22][store_count]: 0
attr[7][attr_name]: 毛重
attr[7][id]: 7
attr[7][attr_value]: 100g
attr[8][attr_name]: 产地
attr[8][id]: 8
attr[8][attr_value]: 中国

3、返回数据

名称备注
id商品id
goods_name商品名
goods_logo商品logo
goods_price商品价格
goods_number总库存
is_hot是否热卖 1 是；0 否
is_on_sale是否上架 1 是；0 否
is_free_shipping是否包邮 1 是；0 否
is_recommend是否推荐 1 是；0 否
is_new是否新品 1 是；0 否
sales_num销量
sort排序
market_price市场价
cost_price成本价
goods_remark商品简介
goods_desc商品详情
weight商品重量
volume商品体积
keywords商品关键字
comments_num评论数
collect_num收藏数
mould_id运费模板id
type_name所属模型名
brand_name所属品牌名
cate_name所属分类名
goods_attr商品属性值集合

4、返回示例

{
                "id": 61,
                "goods_name": "iphone xr 没朋友啊",
                "goods_price": "1000.00",
                "market_price": "0.00",
                "cost_price": "0.00",
                "goods_number": 100,
                "frozen_number": 0,
                "goods_remark": "11111111",
                "goods_desc": "<p>test</p>",
                "goods_logo": "/uploads/goods/20190528/a3fe2eccd3a90a71.jpg",
                "type_id": 16,
                "brand_id": 3,
                "cate_id": 72,
                "mould_id": 0,
                "weight": 0,
                "volume": 0,
                "keywords": "",
                "comments_num": 0,
                "collect_num": "0",
                "sales_num": 0,
                "is_on_sale": 1,
                "is_free_shipping": 1,
                "is_recommend": 1,
                "is_new": 1,
                "is_hot": 1,
                "sort": 50,
                "suppliers_id": 0,
                "goods_attr": [
                    {
                        "id": "7",
                        "attr_name": "毛重",
                        "attr_value": "180g"
                    },
                    {
                        "id": "8",
                        "attr_name": "产地",
                        "attr_value": "中国"
                    }
                ],
                "cate_name": "手机",
                "type_name": "手机",
                "brand_name": "Apple"
    }

9.6、商品删除

1、请求地址

DELETE /goods/[:id]

需进行token认证

[:id] 为商品id

示例： http://adminapi.tbyue.com/goods/17

2、请求参数

无

3、返回数据

无

4、返回示例

无

9.7、商品相册删除

1、请求地址

DELETE /delpics/[:id]

需进行token认证

[:id] 为商品相册图片id

示例： http://adminapi.tbyue.com/delpics/17

2、请求参数

无

3、返回数据

无

4、返回示例

无

十、订单

10.1、订单列表

1、请求地址

GET /orders

需进行token认证

示例： http://adminapi.tbyue.com/orders

2、请求参数

无

3、返回数据

名称备注
total总数量
per_page每页显示数
current_page当前页码
last_page总页数
data数据集

–其中：data数据集

名称备注
id订单id
order_sn订单编号
user_id用户id
order_status订单状态
consignee收货人姓名
phone收货人手机号
address收货人地址
shipping_code物流英文名
shipping_name物流中文名
shipping_sn物流单号
pay_code支付方式英文名
pay_name支付方式中文名
goods_price商品总价
shipping_price运费
coupon_price优惠金额
order_amount应付款
total_amount订单总额
nickname用户昵称
invoice_title发票抬头
taxpayer纳税识别号
invoice_desc发票内容
user_note用户备注
create_time下单时间
shipping_time发货时间
confirm_time收货确认时间
pay_time支付时间

4、返回示例

[
            {
                "id": 10,
                "order_sn": "1559134264534731",
                "user_id": 1,
                "order_status": "待付款",
                "consignee": "小小",
                "address": "北京市顺义区马坡镇黑马程序员",
                "phone": "19912345678",
                "shipping_code": "yuantong",
                "shipping_name": "圆通",
                "shipping_sn": "",
                "pay_code": "alipay",
                "pay_name": "支付宝",
                "invoice_title": "",
                "taxpayer": "",
                "invoice_desc": null,
                "user_note": "",
                "goods_price": "290400.00",
                "shipping_price": "0.00",
                "coupon_price": "0.00",
                "order_amount": "290400.00",
                "total_amount": "290400.00",
                "shipping_time": 0,
                "confirm_time": 0,
                "pay_time": 0,
                "nickname": "199****5678"
            },
            {
                "id": 9,
                "order_sn": "1559134151617041",
                "user_id": 1,
                "order_status": "待付款",
                "consignee": "小小",
                "address": "北京市顺义区马坡镇黑马程序员",
                "phone": "19912345678",
                "shipping_code": "yuantong",
                "shipping_name": "圆通",
                "shipping_sn": "",
                "pay_code": "alipay",
                "pay_name": "支付宝",
                "invoice_title": "",
                "taxpayer": "",
                "invoice_desc": null,
                "user_note": "",
                "goods_price": "0.00",
                "shipping_price": "0.00",
                "coupon_price": "0.00",
                "order_amount": "0.00",
                "total_amount": "0.00",
                "shipping_time": 0,
                "confirm_time": 0,
                "pay_time": 0,
                "nickname": "199****5678"
            }
]

10.2、商品详情

1、请求地址

GET /orders/[:id]

需进行token认证

[:id] 为商品id

示例： http://adminapi.tbyue.com/orders/10

2、请求参数

无

3、返回数据

名称备注
id订单id
order_sn订单编号
user_id用户id
order_status订单状态
consignee收货人姓名
phone收货人手机号
address收货人地址
shipping_code物流英文名
shipping_name物流中文名
shipping_sn物流单号
pay_code支付方式英文名
pay_name支付方式中文名
goods_price商品总价
shipping_price运费
coupon_price优惠金额
order_amount应付款
total_amount订单总额
nickname用户昵称
invoice_title发票抬头
taxpayer纳税识别号
invoice_desc发票内容
user_note用户备注
create_time下单时间
shipping_time发货时间
confirm_time收货确认时间
pay_time支付时间
order_goods订单商品数据集

–其中：order_goods数据集

名称备注
idid
order_id订单id
goods_id商品id
spec_goods_id规格商品id
number购买数量
goods_name商品名称
goods_logo商品名logo
goods_price商品单价
spec_value_names规格值中文名
is_comment是否评价 0否，1是
status发货状态：0未发货，1已发货，2已换货，3已退货

4、返回示例

{
        "id": 10,
        "order_sn": "1559134264534731",
        "user_id": 1,
        "order_status": "待付款",
        "consignee": "小小",
        "address": "北京市顺义区马坡镇黑马程序员",
        "phone": "19912345678",
        "shipping_code": "yuantong",
        "shipping_name": "圆通",
        "shipping_sn": "",
        "pay_code": "alipay",
        "pay_name": "支付宝",
        "invoice_title": "",
        "taxpayer": "",
        "invoice_desc": null,
        "user_note": "",
        "goods_price": "290400.00",
        "shipping_price": "0.00",
        "coupon_price": "0.00",
        "order_amount": "290400.00",
        "total_amount": "290400.00",
        "shipping_time": 0,
        "confirm_time": 0,
        "pay_time": 0,
        "nickname": "199****5678",
        "order_goods": [
            {
                "id": 12,
                "order_id": 10,
                "goods_id": 1,
                "spec_goods_id": 1,
                "number": 4,
                "goods_name": "荣耀10青春版 幻彩渐变 2400万AI自拍 全网通版4GB+64GB 渐变蓝 移动联通电信4G全面屏手机 双卡双待",
                "goods_logo": "/uploads/goods/20190528/865565d919219154.jpg",
                "goods_price": "8000.00",
                "spec_value_names": "颜色：黑色 内存：32G",
                "is_comment": "否",
                "status": "未发货"
            },
            {
                "id": 13,
                "order_id": 10,
                "goods_id": 1,
                "spec_goods_id": 2,
                "number": 21,
                "goods_name": "荣耀10青春版 幻彩渐变 2400万AI自拍 全网通版4GB+64GB 渐变蓝 移动联通电信4G全面屏手机 双卡双待",
                "goods_logo": "/uploads/goods/20190528/865565d919219154.jpg",
                "goods_price": "8000.00",
                "spec_value_names": "颜色：黑色 内存：64G",
                "is_comment": "否",
                "status": "未发货"
            }
        ]
    }

明廷良
关注
  • 0
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
品优购网上商城主要分为网站前台、运营商后台、商家管理后台
12-18
1. 品优购简介 品优购网上商城是一个综合性的 B2B2C 平台，类似京东商城、天猫商城。网站采用商家入驻的模式，商家入驻平台提交申请，有平台进行资质审核，审核通过后，商家拥有独立的管理后台录入商品信息。商品经过平台审核后即可发布。 品优购网上商城主要分为网站前台、运营商后台、商家管理后台三个子系统 1.1 网站前台 主要包括网站首页、商家首页、商品详细页、搜索页、会员中心、订单与支付相关页面、秒杀频道等。 1.2 运营商后台 是运营商的运营人员的管理后台。 主要包括商家审核、品牌管理、规格管理、模板管理、商品分类管理、商品审核、广告类型管理、广告管理、订单查询、商家结算等。 1.3 商家管理后台 入驻的商家进行管理的后台，主要功能是对商品的管理以及订单查询统计、资金结算等功能。
品优购电商系统开发文档
07-06
黑马大型电商项目开发文档，里面涉及阿里dubbo，spring boot,docker,分布式，fastdfs文件系统
品优购项目权限接口
呀哈的博客
11-28 290
封装无限极菜单分类方法 if(!function_exists("get_cate_list")){ //返回无限级分类菜单 function get_cate_list($list,$pid=0,$f=0){ //声明一个静态数组存储处理后的数据 static $arr = []; foreach($list as $val){ if($val['pid']==$pid){ $val
品优购06——运营商后台(商品管理)
武汉小喽啰
02-19 689
1. 待审核商品列表 pinyougou-manager-web工程中 1.1 后端 1.2 前端 1）controller层goodsController.js /* * 定义数组，记录状态信息 * */ $scope.status=['未审核','已审核','审核未通过','关闭'];//商品状态 // 查询分类信息 $scope.itemCatList = []; $s...
springCloud+Vue改造品优购第三章--------引入接口文档测试工具Swagger
weiqiang2的博客
08-20 312
第一步 加入依赖 &lt;!-- swagger文档 --&gt; &lt;dependency&gt; &lt;groupId&gt;io.springfox&lt;/groupId&gt; &lt;artifactId&gt;springfox-swagger2&lt;/artifactId&gt; ...
tp5框架开发的restful API接口自动生成文档源码.zip
04-07
tp5框架开发的restful API接口自动生成文档源码
thinkphp5-restfulapi:restful-api风格接口 APP接口 APP接口权限 oauth2.0 接口版本管理 接口鉴权
05-06
ThinkPHP restfulapi基于ThinkPHP5.1* 基础上开发的一个简单的restful api ，带权限验证等ThinkPHP5.1的运行环境要求PHPPHP7.2+以上。详细开发文档参考使用目前tp5.1相关新增功能，包含容器依赖注入、Facade、验证器...
基于ThinkPHP 5的RESTful API设计源码
最新发布
03-28
基于ThinkPHP 5的RESTful API源码：包含214个文件，使用PHP技术开发，实现了一个基于TP5框架的RESTful风格接口，支持简单的OAuth2.0授权，适合用于构建企业级API服务。
完整的Thinkphp5+LayUI开源后台管理系统源码.rar
08-05
完整的Thinkphp5+LayUI开源后台管理系统源码包含数据库表结构和信息,极大的节省了开发时间。采用的是thinphp5.0版本,安装后记得开启伪静态处理。
ThinkPHP5后台管理系统网站源码
09-29
基于ThinkPHP5开发的后台管理系统网站源码，含菜单管理，auth角色管理，用户管理，日志管理，内容管理，栏目管理，文章管理。可以作为网站的后台系统使用。含sql数据库。
品优购全部资料及教程
06-01
里面是最新黑马第49期培训班的项目教学视频，及其所需的所有的资源文件，老师讲的很好。
品优购电商项目资料（案例笔记素材）
11-25
品优购电商项目资料（案例笔记素材）
品优购配套软件
06-29
品优购配套软件全网独家，网盘链接
pinyougou.sql
11-12
该资源为本博客PYG项目中第一天的建表语句，所用到的数据库为MySQL数据库。
黑马品优购电商项目全套资源
11-30
前端：angularJS + Bootstrap 后台：SSM（springmvc + spring + mybatis） 数据库：mysql，使用mycat读写分离 开发模式：SOA 服务中间件：dubbox，需要和zookeeper配合使用 注册中心：zookeeper 消息中间件：Activemq，使用弹簧JMS 负载均衡：nginx的的 搜索：Solr中的集群（solrCloud），配合动物园管理员搭建，使用弹簧-数据-索洛 缓存：Redis的的集群，使用弹簧数据redis的的 图片存储：fastDFS集群 | |网页静态化： freemarker的 单点登录：cas 权限管理：SpringSecurity， 跨域：cros 支付：微信扫描 短信验证：阿里大于 密码加密：BCrypt 富文本：KindEditor 事务：声明式事务 任务调度：spring task
thinkphp5订单接口的分析和编写的过程（1）
骨子里的偏爱
03-03 408
控制器： class Order extends BaseController { //订单管理 //用户选择后首先，向API提交所选中的商品的信息 //API接收到信息后，需要检测订单相关商品的库存量 //有库存，并且下单成功，告诉客户端可以进行支付 //调用支付接口，进行支付 //服务器调用微信接口进行微信支付 //微信会返回一个支付的结果（异步） //成功：需要进行库存量的检查 //成功：进行库存量的减少 //前置判断 判
项目4_品优购_day5
郭叶兵的博客
01-03 174
一:实现三级商品分类列表查询功能 //根据上级ID返回列表 public List<TbItemCat> findByParentId(Long parentId); public List<TbItemCat> findByParentId(Long parentId) { TbItemCatExample example=new TbItemCatExample...
05、品优购——Demo案例配置演示
一诺
09-10 696
       废话唠叨的不少了，接下来我们写个小demo实现一下吧！ 一、项目创建步骤        1、创建工程（选择maven中的web工程） 注意先提前配置好自己的maven仓库哦！ 因为是两个服务间的调用，所以我们需要来创建两个服务，与第一个服务创建流程一样大家快动手创建一下吧！        2、创建子文件夹 分别存放java文件以及相关配置文件。        3...
关于品优购大型电商开发问题解答以及开发知识点详解day1（3）
weixin_45989389的博客
06-27 122
关于品优购大型电商开发问题解答以及开发知识点详解day1（3） 1.数据库的创建以及逆向工程 ​ 具体按照文档操作 ​ 两点问题 ​ 1.如果mysql版本为mysql8的同学需要导入在dao层换mysql8的jar包 并去除mysql5的jar包 ​ 2.将pinyougou—parent的pom文件规定的版本改为mysql8版本 (防止以后项目报错)，如果不改连接不上数据库。 ​ 3.！！！逆向工程只可运行一遍， 如果运行多遍会 .java文件不会受影响，而*Mapper.xml里的文件会写
thinkphp v5后台源码
07-21
### 回答1： ThinkPHP是一款开源的PHP开发框架，ThinkPHP v5是其最新版本。ThinkPHP v5后台源码是指使用ThinkPHP v5框架开发的网站后台管理系统的源代码。 ThinkPHP v5框架在后台开发中具有许多优点。首先，它提供了强大的开发功能和丰富的开发工具，可以快速高效地开发出功能完善的后台系统。其次，ThinkPHP v5框架采用了MVC（模型-视图-控制器）的架构模式，有助于代码的组织和维护。此外，它还提供了丰富的数据库操作方法和数据验证机制，使得后台系统与数据库的交互更加简单高效。 在ThinkPHP v5后台源码中，通常会包含一些常见的后台管理功能，例如用户管理、权限管理、角色管理、菜单管理、日志管理等。这些功能可以帮助管理员对网站的内容和用户进行管理和控制。此外，根据具体的业务需求，开发者还可以根据ThinkPHP v5框架的灵活性进行二次开发，添加自定义的功能模块。 使用ThinkPHP v5后台源码可以带来许多好处。首先，它可以节省开发时间和成本，因为框架提供了许多预置的功能模块和代码库，可以直接使用，无需从头开始开发。其次，使用框架可以提高系统的稳定性和安全性，因为框架内部有一系列的安全机制和防御措施。最后，使用ThinkPHP v5后台源码可以遵循一些最佳实践和设计原则，使得代码结构更加清晰、易于维护和扩展。 总之，ThinkPHP v5后台源码是使用ThinkPHP v5框架开发的网站后台管理系统的源代码。它具备强大的开发功能和丰富的开发工具，可以帮助开发者快速、高效地构建功能完善的后台系统，并提供了一些常见的后台管理功能。使用该源码可以节省开发时间和成本，提高系统的稳定性和安全性，以及遵循最佳实践和设计原则。 ### 回答2： ThinkPHP v5是一款开源的PHP框架，用于快速开发Web应用程序。它提供了一套完善的开发工具和功能，方便开发者进行快速、高效的开发工作。 ThinkPHP v5后台源码是指使用ThinkPHP v5框架开发的后台管理系统的源代码。后台管理系统是一个用于管理网站后台信息的应用程序，通常包括用户管理、权限管理、内容管理等功能。 ThinkPHP v5后台源码具有以下特点： 1. 高度模块化：源码采用模块化开发方式，可以方便地进行功能扩展和定制化开发，满足不同项目的需求。 2. 轻量级：框架本身代码轻巧，运行速度快，对服务器资源的占用较少。 3. 安全性高：源码使用了一些安全机制来保护系统免受恶意攻击，例如SQL注入、跨站脚本等。 4. 可靠性强：框架底层经过多次迭代和测试，稳定性和可靠性得到了保证。 5. 注重开发效率：源码提供了大量的开发工具和辅助函数，开发者可以快速编写出高质量的代码，提高开发效率。 6. 良好的文档支持：ThinkPHP v5拥有完善的官方文档，对开发者提供了详细的使用说明和示例代码，方便开发者快速上手。 总之，ThinkPHP v5后台源码是一款功能强大的后台管理系统框架，适用于各类Web应用程序的开发，具备高度的可扩展性、安全性和可靠性，并且能够提高开发效率，是PHP开发者的不错选择。 ### 回答3： thinkphp v5后台源码是基于thinkphp框架开发的一套用于搭建网站后台管理系统的源代码。thinkphp是国内非常有名的PHP框架之一，具有易于学习、灵活、高效等特点。v5是thinkphp框架的第五个主要版本，相较于前几个版本，v5在性能、安全性以及开发便利性方面都有很大的提升。 thinkphp v5后台源码提供了一套完整的后台管理系统模板，包括用户管理、权限管理、菜单管理、日志管理等功能。它提供了丰富的组件和插件，可以根据实际需求进行二次开发，快速构建出符合自己需求的个性化后台管理系统。 thinkphp v5后台源码采用了MVC（Model-View-Controller）的架构模式，将数据模型、视图和控制器进行了分离，使代码更加清晰易懂。它还支持数据库的操作，可以轻松实现对用户、文章、分类等数据的增删改查操作。同时，它还提供了丰富的验证和过滤机制，有效保障了数据的安全性。 thinkphp v5后台源码还引入了Composer，可以方便地管理代码依赖和第三方库的引入，提高了开发效率。它还使用了模板引擎，可以快速生成页面，实现前后端的分离。 总之，thinkphp v5后台源码是一套功能强大、灵活易用的后台管理系统开发框架，可以帮助开发者快速构建出符合自己需求的后台管理系统，提高开发效率和代码质量。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值