烘焙预约小程序 - API接口文档

小程序端与管理端接口定义，按业务模块组织，包含文件路径、请求/响应参数

接口概述

基本信息

Base URL	以实际部署为准（如 `https://api.xxx.com`）
协议	HTTPS
数据格式	JSON
字符编码	UTF-8
认证方式	Bearer Token（JWT）

通用响应格式

{
  "code": 1000,
  "message": "success",
  "data": {}
}

错误码说明

错误码	说明
1000	成功
1001	请求参数错误
1002	未授权（Token无效或过期）
1003	权限不足
1004	资源不存在
1005	服务器内部错误

模块 A：用户点单

商品浏览、购物车、下单流程

A.1 小程序端接口

GET /app/goods/info/list 待开发

商品列表

文件路径modules/goods/controller/app/info.ts

请求参数

参数名	类型	必填	说明
shopId	number	否	门店ID
typeId	number	否	分类ID
keyword	string	否	搜索关键词

响应参数

字段	类型	说明
list	array	商品列表
list[].id	number	商品ID
list[].name	string	商品名称
list[].price	number	价格（分）
list[].pic	string	图片URL
list[].stock	number	库存

GET /app/goods/info/info 待开发

商品详情

文件路径modules/goods/controller/app/info.ts

请求参数

参数名	类型	必填	说明
id	number	是	商品ID

GET /app/goods/type/list 待开发

商品分类

文件路径modules/goods/controller/app/type.ts

POST /app/order/info/create 待开发

创建订单

文件路径modules/order/controller/app/info.ts

请求参数

参数名	类型	必填	说明
shopId	number	是	门店ID
type	number	是	0-自取 1-外卖 2-堂食
addressId	number	否	地址ID（外卖必填）
seatNo	string	否	座位号（堂食时可选，支持扫码携带或手动输入）
couponId	number	否	优惠券ID
remark	string	否	备注
goods	array	是	商品列表
goods[].id	number	是	商品ID
goods[].num	number	是	数量
goods[].specIds	array	否	规格值ID列表

座位号来源：1.用户手动输入 2.扫码点餐URL携带?seatNo=A5 3.不填写使用取餐号取餐

响应参数

字段	类型	说明
id	number	订单ID
orderNo	string	订单号
takeNo	string	取餐号（按类型前缀：A-自取/W-外卖/D-堂食）
totalPrice	number	总价（分）
payPrice	number	应付金额（分）

A.2 管理后台接口

接口	路径	状态	文件
商品列表	`POST /admin/goods/info/page`	待开发	modules/goods/controller/admin/info.ts
商品新增	`POST /admin/goods/info/add`	待开发	modules/goods/controller/admin/info.ts
商品修改	`POST /admin/goods/info/update`	待开发	modules/goods/controller/admin/info.ts
商品删除	`POST /admin/goods/info/delete`	待开发	modules/goods/controller/admin/info.ts
分类管理	`POST /admin/goods/type/*`	待开发	modules/goods/controller/admin/type.ts
规格管理	`POST /admin/goods/spec/*`	待开发	modules/goods/controller/admin/spec.ts
评论管理	`POST /admin/goods/comment/*`	待开发	modules/goods/controller/admin/comment.ts

模块 B：外卖配送

订单支付、配送、退款流程

B.1 小程序端接口

POST /app/order/pay/wxMiniPay 待开发

微信小程序支付

文件路径modules/order/controller/app/pay.ts

请求参数

参数名	类型	必填	说明
orderId	number	是	订单ID

响应参数

字段	类型	说明
timeStamp	string	时间戳
nonceStr	string	随机字符串
package	string	订单详情扩展字符串
signType	string	签名方式
paySign	string	签名

POST /app/order/info/page 待开发

订单列表

文件路径modules/order/controller/app/info.ts

请求参数

参数名	类型	必填	说明
status	number	否	订单状态
type	number	否	0-自取 1-外卖 2-堂食
page	number	否	页码
size	number	否	每页条数

响应参数

字段	类型	说明
list[].type	number	0-自取 1-外卖 2-堂食
list[].takeNo	string	取餐号（A/W/D前缀）
list[].seatNo	string	座位号（堂食订单时返回）

接口	路径	状态	文件
订单详情	`GET /app/order/info/info`	待开发	modules/order/controller/app/info.ts
订单统计	`GET /app/order/info/userCount`	待开发	modules/order/controller/app/info.ts
取消订单	`POST /app/order/info/cancel`	待开发	modules/order/controller/app/info.ts
申请退款	`POST /app/order/info/refund`	待开发	modules/order/controller/app/info.ts
确认收货	`POST /app/order/info/confirm`	待开发	modules/order/controller/app/info.ts
物流信息	`GET /app/order/info/logistics`	待开发	modules/order/controller/app/info.ts

B.2 管理后台接口

接口	路径	状态	文件
订单列表	`POST /admin/order/info/page`	待开发	modules/order/controller/admin/info.ts
订单详情	`GET /admin/order/info/info`	待开发	modules/order/controller/admin/info.ts
退款处理	`POST /admin/order/info/refundHandle`	待开发	modules/order/controller/admin/info.ts
发货	`POST /admin/order/info/deliver`	待开发	modules/order/controller/admin/info.ts

筛选条件：type 支持 0-自取 1-外卖 2-堂食；keyword 支持订单号/手机号/座位号搜索
响应字段：takeNo（取餐号 A/W/D前缀）、seatNo（座位号，堂食订单时返回）

模块 C：预约

预约表单、核销流程

C.1 小程序端接口

POST /app/bake/reservation/add 待开发

提交预约

预计文件modules/bake/controller/app/reservation.ts

请求参数

参数名	类型	必填	说明
shopId	number	是	门店ID
type	number	是	0-自提 1-配送
contactName	string	是	联系人姓名
phone	string	是	联系电话
reserveDate	string	是	预约日期 YYYY-MM-DD
reserveTime	string	是	预约时间 HH:mm
address	object	否	配送地址（配送时必填）
voucherPic	string	否	核销券码图片URL
remark	string	否	备注

响应参数

字段	类型	说明
id	number	预约ID

POST /app/bake/reservation/page 待开发

预约列表

预计文件modules/bake/controller/app/reservation.ts

GET /app/bake/reservation/info 待开发

预约详情

POST /app/bake/reservation/cancel 待开发

取消预约

C.2 管理后台接口

接口	路径	状态	预计文件
预约列表	`POST /admin/bake/reservation/page`	待开发	modules/bake/controller/admin/reservation.ts
预约详情	`GET /admin/bake/reservation/info`	待开发	modules/bake/controller/admin/reservation.ts
预约修改	`POST /admin/bake/reservation/update`	待开发	modules/bake/controller/admin/reservation.ts
预约删除	`POST /admin/bake/reservation/delete`	待开发	modules/bake/controller/admin/reservation.ts
预约核销	`POST /admin/bake/reservation/verify`	待开发	modules/bake/controller/admin/reservation.ts
预约统计	`GET /admin/bake/reservation/count`	待开发	modules/bake/controller/admin/reservation.ts

公共模块

用户、门店、轮播图、营销、客服、应用、系统管理

用户模块

小程序端

接口	路径	状态
小程序登录	`POST /app/user/login/mini`	待开发
手机号登录	`POST /app/user/login/phone`	待开发
用户信息	`GET /app/user/info/person`	待开发
更新用户	`POST /app/user/info/updatePerson`	待开发
绑定手机	`POST /app/user/info/bindPhone`	待开发
地址CRUD	`POST /app/user/address/*`	待开发
会员列表	`GET /app/user/vip/list`	待开发

管理后台

接口	路径	状态
用户管理	`POST /admin/user/info/*`	待开发
地址管理	`POST /admin/user/address/*`	待开发
会员管理	`POST /admin/user/vip/*`	待开发

门店模块

接口	路径	状态
门店列表(APP)	`GET /app/shop/info/list`	待开发
门店详情(APP)	`GET /app/shop/info/info`	待开发
门店管理	`POST /admin/shop/info/*`	待开发
门店账号绑定	`POST /admin/shop/info/update`	待开发

轮播图模块

接口	路径	状态
轮播图列表(APP)	`GET /app/info/banner/list`	待开发
轮播图管理	`POST /admin/info/banner/*`	待开发

营销模块

接口	路径	状态
优惠券列表(APP)	`POST /app/market/coupon/info/page`	待开发
领取优惠券	`POST /app/market/coupon/user/receive`	待开发
我的优惠券	`GET /app/market/coupon/user/my`	待开发
优惠券管理	`POST /admin/market/coupon/info/*`	待开发
用户优惠券管理	`POST /admin/market/coupon/user/*`	待开发

客服模块

接口	路径	状态
创建会话	`POST /app/cs/session/create`	待开发
会话详情	`GET /app/cs/session/detail`	待开发
消息列表	`POST /app/cs/msg/page`	待开发
未读数	`GET /app/cs/msg/unreadCount`	待开发
会话管理	`POST /admin/cs/session/page`	待开发
消息管理	`POST /admin/cs/msg/*`	待开发

应用模块

接口	路径	状态
版本检查	`GET /app/app/version/check`	待开发
提交反馈	`POST /app/app/feedback/submit`	待开发
提交投诉	`POST /app/app/complain/submit`	待开发
版本管理	`POST /admin/app/version/*`	待开发
反馈管理	`POST /admin/app/feedback/*`	待开发
投诉管理	`POST /admin/app/complain/*`	待开发
套餐管理	`POST /admin/app/goods/*`	待开发

系统管理

接口	路径	状态
登录	`POST /admin/base/open/login`	待开发
后台用户	`POST /admin/base/sys/user/*`	待开发
角色管理	`POST /admin/base/sys/role/*`	待开发
菜单管理	`POST /admin/base/sys/menu/*`	待开发
参数管理	`POST /admin/base/sys/param/*`	待开发
日志管理	`POST /admin/base/sys/log/*`	待开发
字典管理	`POST /admin/dict/info/*`	待开发
文件空间	`POST /admin/space/info/*`	待开发
任务管理	`POST /admin/task/info/*`	待开发
回收站	`POST /admin/recycle/data/*`	待开发

待开发类与方法

Entity 实体类

modules/bake/entity/reservation.ts
- BakeReservationEntity
  - id: number - 主键
  - shopId: number - 门店ID
  - userId: number - 用户ID
  - contactName: string - 联系人姓名
  - phone: string - 联系电话
  - type: number - 0-自提 1-配送
  - reserveDate: Date - 预约日期
  - reserveTime: string - 预约时间
  - address: JSON - 配送地址
  - voucherPic: string - 核销券码图片
  - remark: string - 备注
  - status: number - 0-已预约 1-已完成 2-已取消

Service 服务类

modules/bake/service/reservation.ts
- BakeReservationService extends BaseService
  - add(dto) - 提交预约
  - page(query) - 分页查询
  - info(id) - 获取详情
  - cancel(id, userId) - 取消预约
  - verify(id, operatorId) - 核销预约
  - count(shopId?) - 预约统计

Controller 控制器

modules/bake/controller/app/reservation.ts
- BakeAppReservationController
  - @Post('/add') add()
  - @Post('/page') page()
  - @Get('/info') info()
  - @Post('/cancel') cancel()

modules/bake/controller/admin/reservation.ts
- BakeAdminReservationController
  - @Post('/page') page()
  - @Get('/info') info()
  - @Post('/update') update()
  - @Post('/delete') delete()
  - @Post('/verify') verify()
  - @Get('/count') count()

接口统计

小程序端

总接口数

管理后台

103

总接口数

模块	小程序	管理后台
用户点单	8	15+
外卖配送	11	7
预约	4	6
用户	10	12+
门店	2	5+
轮播图	1	5+
营销	3	10+
客服	4	6+
应用	3	15+
系统	-	20+

文档版本：v2.1 · 2026-02-25（新增堂食类型和座位号）

← 返回文档总览