docs:删除过时文档

This commit is contained in:
2025-12-02 10:52:06 +08:00
parent 97bf6cacb0
commit 92e4f8caa4
2 changed files with 0 additions and 201 deletions

View File

@@ -1,93 +0,0 @@
# 管理后台 API 设计Admin API
- 项目TakeoutSaaS.AdminApi
- 版本前缀:/api/admin/v1
- 认证JWT + RBAC平台、租户、商家角色
- 租户识别X-Tenant-Id 头或 Token Claim
## 1. 通用规范
- Content-Type: application/json
- 成功响应
{
"success": true,
"code": 200,
"message": "OK",
"data": {}
}
- 失败响应
{
"success": false,
"code": 422,
"message": "业务异常"
}
## 2. 认证与权限
- POST /api/admin/v1/auth/login
- POST /api/admin/v1/auth/refresh
- GET /api/admin/v1/auth/profile
- 角色PlatformAdmin、TenantAdmin、MerchantAdmin、Staff
## 3. 租户与商家管理
- 租户
- GET /api/admin/v1/tenants
- POST /api/admin/v1/tenants
- PUT /api/admin/v1/tenants/{id}
- PATCH/api/admin/v1/tenants/{id}/status
- 商家
- GET /api/admin/v1/merchants
- POST /api/admin/v1/merchants
- GET /api/admin/v1/merchants/{id}
- PUT /api/admin/v1/merchants/{id}
- DELETE /api/admin/v1/merchants/{id}
- 门店
- GET /api/admin/v1/stores
- POST /api/admin/v1/stores
## 4. 菜品管理
- 分类
- GET /api/admin/v1/categories
- POST /api/admin/v1/categories
- PUT /api/admin/v1/categories/{id}
- DELETE /api/admin/v1/categories/{id}
- 菜品
- GET /api/admin/v1/dishes
- POST /api/admin/v1/dishes
- GET /api/admin/v1/dishes/{id}
- PUT /api/admin/v1/dishes/{id}
- PATCH/api/admin/v1/dishes/batch-status
## 5. 订单与售后
- 订单
- GET /api/admin/v1/orders
- GET /api/admin/v1/orders/{id}
- POST /api/admin/v1/orders/{id}/accept
- POST /api/admin/v1/orders/{id}/cook
- POST /api/admin/v1/orders/{id}/deliver
- POST /api/admin/v1/orders/{id}/complete
- POST /api/admin/v1/orders/{id}/cancel
- 售后
- GET /api/admin/v1/refunds
- POST /api/admin/v1/refunds/{id}/approve
- POST /api/admin/v1/refunds/{id}/reject
## 6. 营销与用户运营
- 优惠券
- GET /api/admin/v1/coupons
- POST /api/admin/v1/coupons
- PUT /api/admin/v1/coupons/{id}
- PATCH/api/admin/v1/coupons/{id}/status
- 评价
- GET /api/admin/v1/reviews
- POST /api/admin/v1/reviews/{id}/reply
## 7. 统计报表
- GET /api/admin/v1/statistics/merchant/overview?merchantId=
- GET /api/admin/v1/statistics/platform/overview
## 8. 文件上传
- POST /api/admin/v1/files/upload (multipart/form-data)
## 9. WebSocket可选
- ws://{host}/ws/admin?token=xxx
- 主题order.new、order.status、refund.updated

View File

@@ -1,108 +0,0 @@
# 小程序/用户端 API 设计Mini API
- 项目TakeoutSaaS.MiniApi
- 版本前缀:/api/mini/v1
- 认证JWT小程序登录态/ 第三方登录(微信/支付宝)
- 租户识别X-Tenant-Id 头或域名/小程序场景参数
## 1. 通用规范
- Content-Type: application/json
- 成功响应
{
"success": true,
"code": 200,
"message": "OK",
"data": {}
}
## 2. 认证登录
- 微信登录
- POST /api/mini/v1/auth/wechat/login
- { code, encryptedData?, iv? }
- 刷新Token
- POST /api/mini/v1/auth/refresh
- 获取用户信息
- GET /api/mini/v1/me
## 3. 商家与门店
- 获取推荐商家
- GET /api/mini/v1/merchants/recommend?lat=&lng=&pageIndex=&pageSize=
- 商家详情(含门店与公告)
- GET /api/mini/v1/merchants/{id}
- 门店列表(按距离)
- GET /api/mini/v1/merchants/{id}/stores?lat=&lng=
## 4. 菜品与分类
- 分类列表
- GET /api/mini/v1/categories?merchantId=
- 菜品列表
- GET /api/mini/v1/dishes?merchantId=&categoryId=&keyword=&sort=
- 菜品详情
- GET /api/mini/v1/dishes/{id}
## 5. 购物车
- 获取购物车
- GET /api/mini/v1/cart?merchantId=
- 同步购物车(幂等)
- PUT /api/mini/v1/cart
- { merchantId, items:[{dishId,specId?,quantity}] }
- 清空购物车
- DELETE /api/mini/v1/cart?merchantId=
## 6. 地址簿
- 地址列表
- GET /api/mini/v1/addresses
- 新增地址
- POST /api/mini/v1/addresses
- 更新地址
- PUT /api/mini/v1/addresses/{id}
- 删除地址
- DELETE /api/mini/v1/addresses/{id}
- 设为默认地址
- POST /api/mini/v1/addresses/{id}/default
## 7. 订单
- 创建订单(下单)
- POST /api/mini/v1/orders
- { merchantId, storeId, items:[{dishId,specId?,quantity}], addressId, remark?, couponId? }
- 订单列表
- GET /api/mini/v1/orders?status=&pageIndex=&pageSize=
- 订单详情
- GET /api/mini/v1/orders/{id}
- 取消订单
- POST /api/mini/v1/orders/{id}/cancel { reason }
- 再来一单
- POST /api/mini/v1/orders/{id}/reorder
## 8. 支付
- 预下单(获取支付参数)
- POST /api/mini/v1/payments
- { orderId, method: wechat|alipay }
- 查询支付状态
- GET /api/mini/v1/payments/{paymentNo}
- 第三方回调(回调专用)
- POST /api/mini/v1/payments/callback/wechat
- POST /api/mini/v1/payments/callback/alipay
## 9. 优惠券
- 可领取优惠券列表
- GET /api/mini/v1/coupons/available?merchantId=
- 领取优惠券
- POST /api/mini/v1/coupons/{id}/receive
- 我的优惠券
- GET /api/mini/v1/user-coupons?status=
## 10. 评价
- 发表评价
- POST /api/mini/v1/reviews { orderId, rating, content?, images?[] }
- 商家评价列表
- GET /api/mini/v1/reviews?merchantId=&rating=&page=
## 11. 文件上传
- 上传评价图片/头像
- POST /api/mini/v1/files/upload (multipart/form-data)
## 12. WebSocket可选
- ws://{host}/ws/mini?token=xxx
- 主题order.status, payment.success