仿乐优电商后台管理接口API文档
目录
内容
1、 API v1.0.0 接口说明
1.1 基本说明
- 后台基路径地址：http://api.leyou.com/api
- 服务端已开启CORS跨域支持
- 数据返回格式：json
1.1.1. 支持的请求方法
- GET（SELECT）：从服务器取出资源（一项或多项）。
- POST（CREATE）：在服务器新建一个资源。
- PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
- PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。
- DELETE（DELETE）：从服务器删除资源。
- HEAD：获取资源的元数据。
- OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。
1.1.2. 通用返回状态说明
| 状态码 |
含义 |
说明 |
| 200 |
OK |
请求成功 |
| 201 |
CREATED |
创建成功 |
| 204 |
DELETED |
删除成功 |
| 400 |
BAD REQUEST |
请求的地址不存在或者包含不支持的参数 |
| 401 |
UNAUTHORIZED |
未授权 |
| 403 |
FORBIDDEN |
被禁止访问 |
| 404 |
NOT FOUND |
请求的资源不存在 |
| 422 |
Unprocesable entity |
[POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误 |
| 500 |
INTERNAL SERVER ERROR |
内部错误 |
|
|
|
2、菜单
2.2、菜单列表
- 请求路径：menu/list
- 请求方法：get
- 请求参数
| 参数名 |
参数说明 |
备注 |
| id |
菜单 ID |
|
| title |
菜单标题 |
|
| path |
路径 |
|
| pid |
父级菜单ID |
|
| sid |
一级子菜单ID字符串 |
|
| descript |
菜单描述 |
|
| create_time |
创建时间 |
|
| modify_time |
修改时间 |
|
| action |
菜单小图标样式 |
|
[
{
"id": 1,
"title": "首页",
"path": "/index",
"pid": 0,
"sid": "6",
"description": "",
"create_time": "2019-12-19 16:46:28",
"modify_tiem": "2019-12-23 18:28:05",
"action": "home",
"items": [
{
"id": 6,
"title": "统计",
"path": "/report",
"pid": 1,
"sid": "",
"description": "",
"create_time": "2019-12-19 16:51:02",
"modify_tiem": "2019-12-19 16:51:02",
"action": ""
}
]
},
{
"id": 2,
"title": "商品管理",
"path": "/item",
"pid": 0,
"sid": "7, 8, 9, 10",
"description": "",
"create_time": "2019-12-19 16:46:29",
"modify_tiem": "2019-12-23 18:28:05",
"action": "apps",
"items": [
{
"id": 7,
"title": "分类管理",
"path": "/category",
"pid": 2,
"sid": "",
"description": "",
"create_time": "2019-12-19 16:56:07",
"modify_tiem": "2019-12-19 16:56:07",
"action": ""
},
{
"id": 8,
"title": "品牌管理",
"path": "/brand",
"pid": 2,
"sid": "",
"description": "",
"create_time": "2019-12-19 16:56:07",
"modify_tiem": "2019-12-19 16:56:07",
"action": ""
},
{
"id": 9,
"title": "商品列表",
"path": "/goodsList",
"pid": 2,
"sid": "",
"description": "",
"create_time": "2019-12-19 16:56:07",
"modify_tiem": "2019-12-19 16:56:07",
"action": ""
},
{
"id": 10,
"title": "规格参数",
"path": "/specification",
"pid": 2,
"sid": "",
"description": "",
"create_time": "2019-12-19 16:56:07",
"modify_tiem": "2019-12-19 16:56:07",
"action": ""
}
]
}
...
]
3、后记
本项目为参考某马视频thinkphp5.1-乐优商城前后端项目开发，相关视频及配套资料可自行度娘或者联系本人。上面为自己编写的开发文档，持续更新。欢迎交流，本人QQ:806797785
前端项目源代码地址：https://gitee.com/gaogzhen/vue-leyou
后端thinkphp源代码地址:https://gitee.com/gaogzhen/leyou-backend-thinkphp
