marco
43f28d358b
- 新增 device-liveness(无障碍存活监控)、internal(内部回写端点)、cps-redirect(CPS 短链落地)三族单文件文档 - API 总览补录此前缺失端点:coupon prompt 频控、report/invite、wxpay 回调、platform 客户端配置、feedback/user/ad 零散读端点 - database 新增 cps_wx_user / device_liveness / launch_confirm_sample 三表文档,更新 OVERVIEW/README/comparison_record/数据库迁移/后端技术实现 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
后端文档库(docs/)
shaguabijia-app-server 的文档都在这里。结构:根目录放总览,其余按领域/用途分目录。
根目录
| 文档 | 作用 |
|---|---|
| 后端技术实现.md | 后端技术方案总览:业务概览、分层架构与目录、登录链路、美团 CPS、领券/比价透传、数据模型、配置与部署、已知问题。想了解"整个后端怎么回事"先看这份。 |
| README.md | 本文件:文档库索引/传送门。 |
子目录
| 目录 | 作用 |
|---|---|
| api/ | API 接口文档:"索引 + 一接口一文件"(组织方式见下)。想查"某个接口的协议"看这里。 |
| database/ | 数据库文档:每张表一个文件(表结构/字段/索引/约定) + 两份迁移指南——数据库迁移.md(Alembic 操作:clone 后建表/日常升级/新增迁移/多 head 排查) + postgres-migration.md(SQLite → PostgreSQL 切换步骤,配套 scripts/init_postgres.py)。想"把库跑起来 / 改表结构 / 查某张表"看这里。 |
| integrations/ | 集成层实现文档:穿山甲验签 / 微信支付 / 极光 / 短信 / 美团 CPS 等 SDK 集成的签名、加解密、协议细节与踩坑。想知道"接外部服务那块到底怎么实现"看这里。 |
| guides/ | 开发 / 上线 / 功能 指南:待办与技术债.md(跨前后端 backlog,P1 鉴权/用户绑定、引擎移植待办等,"还欠什么、以后要补什么"看这份) + 看广告赚金币上线清单.md(看广告发奖上线 checklist) + 邀请功能-实现原理与本地测试.md(invite-mvp 实现原理 + 本地内网全链路测试) + CPS发券分发与微信授权.md(CPS 发券系统交接文档:设群/建活动/生成落地页短链/美团对账/统计 + 微信网页授权拿 openid 做用户级统计;含数据流/表/平台差异/端点/配置/代码地图/排障/技术债)。 |
api/ 目录是怎么组织的(传送门式)
接口多了之后,单个大文件会臃肿、难维护,所以拆成 一个索引 + 一个接口一个文件:
- api/README.md — 入口/传送门
一张总览表列出全部接口(方法、路径、鉴权),每行链接到该接口的独立文档;另含通用约定(错误码、时间格式等)和复用数据结构(
TokenPair/UserOut/CouponCard等)。它本身不展开每个接口的细节,只负责"指路"。 - api/<模块>-<接口>.md — 单接口文档
每个接口一个文件,只写自己的入参 / 出参 / 错误码 / 说明。命名按
<模块>-<接口>,如auth-jverify-login.md、coupon-step.md、meituan-feed.md。
查某个接口的协议:先打开 api/README.md 的总览表 → 找到接口 → 点链接进对应文档。
新增接口时:在
api/下加一个<模块>-<接口>.md,并到api/README.md总览表里补一行链接。这样索引始终是唯一的"传送门",细节各自独立、互不干扰。