114 lines
3.0 KiB
Markdown
114 lines
3.0 KiB
Markdown
# 后端路径速查
|
||
|
||
> Base: `/api/v1` · 响应: `{ code, message, data }`
|
||
|
||
## JWT clientApp（preV1 实际值）
|
||
|
||
| clientApp | actorType | 账号表 |
|
||
|-----------|-----------|--------|
|
||
| USER_H5 | USER | user_user |
|
||
| SHOP_H5 | STORE | store_account |
|
||
| PARTNER_H5 | PARTNER | partner_account |
|
||
| HQ_WEB | HQ | hq_account |
|
||
|
||
Token 含 `actorType` + `actorId` + `clientApp`。请求头：`Authorization`、`X-Client-App`。
|
||
|
||
## 表前缀
|
||
|
||
| 前缀 | 域 |
|
||
|------|-----|
|
||
| user_ | C 端用户、订单、权益、核销 |
|
||
| store_ | 门店、门店账号、结算 |
|
||
| partner_ | 合伙人 |
|
||
| hq_ | 总部账号 |
|
||
| common_ | 商品、资源、事件、工单 |
|
||
| log_ | 第三方、埋点 |
|
||
|
||
## Guard 对照
|
||
|
||
| Guard | 用途 |
|
||
|-------|------|
|
||
| JwtAuthGuard | 需登录 |
|
||
| PhoneVerifiedGuard | C 端需绑定手机（下单/支付） |
|
||
| OptionalJwtAuthGuard | 可选登录（bootstrap） |
|
||
|
||
Admin 路由在 `modules/ops/` 下，前缀 `/admin/*`。
|
||
|
||
## Controller 路由（当前实现）
|
||
|
||
### iam
|
||
|
||
| 路径 | Controller |
|
||
|------|-----------|
|
||
| `POST /auth/session/bootstrap` | UserAuthController |
|
||
| `POST /auth/sms/send` | UserAuthController |
|
||
| `POST /auth/sms/login` | UserAuthController |
|
||
| `GET /user/me` | UserAuthController |
|
||
| `GET/POST/PUT/DELETE /user/addresses` | UserAddressController |
|
||
| `POST /shop/auth/*` | ShopAuthController |
|
||
| `POST /partner/auth/*` | PartnerAuthController |
|
||
| `POST /admin/auth/login` | AdminAuthController |
|
||
|
||
### catalog / trade / benefit / redeem
|
||
|
||
| 路径 | Module |
|
||
|------|--------|
|
||
| `GET /catalog/*` | catalog |
|
||
| `POST/GET /trade/orders` | trade |
|
||
| `GET/POST /benefit/*` | benefit |
|
||
| `POST /redeem/*` | redeem（C 端） |
|
||
| `POST /shop/redeem/*` | redeem（门店） |
|
||
|
||
### store / settlement
|
||
|
||
| 路径 | Module |
|
||
|------|--------|
|
||
| `GET /stores` | store（C 端门店列表） |
|
||
| `GET/POST /partner/stores` | store |
|
||
| `GET /partner/dashboard` | store |
|
||
| `GET /shop/store` | store |
|
||
| `GET /shop/dashboard` | store |
|
||
| `GET /partner/settlement/*` | settlement |
|
||
| `GET /partner/me` | settlement |
|
||
| `GET /partner/orders` | trade |
|
||
|
||
### ops（admin-web）
|
||
|
||
| 路径 | 说明 |
|
||
|------|------|
|
||
| `/admin/dashboard` | 看板 |
|
||
| `/admin/users` | C 端用户 |
|
||
| `/admin/orders` | 订单 |
|
||
| `/admin/stores` | 门店 |
|
||
| `/admin/store-accounts` | 门店账号 |
|
||
| `/admin/store-media` | 门店媒体 |
|
||
| `/admin/partners` | 合伙人 |
|
||
| `/admin/partner-accounts` | 合伙人账号 |
|
||
| `/admin/cities` | 开城 |
|
||
| `/admin/hq-accounts` | 总部账号 |
|
||
| `/admin/benefit/coupons` | 权益券 |
|
||
| `/admin/benefit/ledgers` | 权益流水 |
|
||
| `/admin/redeem-records` | 核销记录 |
|
||
| `/admin/deliveries` | 配送 |
|
||
|
||
### analytics / health
|
||
|
||
| 路径 | Module |
|
||
|------|--------|
|
||
| `POST /analytics/*` | analytics |
|
||
| `GET /health` | health |
|
||
|
||
## 模块 → OWNER
|
||
|
||
| Module | Owner | 主责 |
|
||
|--------|-------|------|
|
||
| iam, trade, benefit, analytics | A | 交易与权益 |
|
||
| store | B | 门店域 |
|
||
| catalog, settlement, ops | C | 开城与结算 |
|
||
| redeem | D | 核销域 |
|
||
|
||
## 禁止
|
||
|
||
- Module A 直写 Module B 的 Prisma 表
|
||
- apps import server 源码
|