ouzhou
0e42e96ddb
新增 admin 模块接口文档(auth login/me、admins CRUD、audit-logs、feedback 处理、stats 概览、user coins/detail/status、wallet 流水、withdraw 对账/刷新/列表) + admin_user/admin_audit_log 两张表文档，更新 api/database README 索引。 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> --------- Co-authored-by: OuYingJun1024 <1034284404@qq.com> Reviewed-on: #12 Co-authored-by: ouzhou <ouzhou@wonderable.ai> Co-committed-by: ouzhou <ouzhou@wonderable.ai>
后端文档库(docs/)
shaguabijia-app-server 的文档都在这里。各文档作用:
| 文档 / 目录 | 作用 |
|---|---|
| 后端技术实现.md | 后端技术方案:业务概览、分层架构与目录、登录链路、美团 CPS、领券透传、数据模型、配置与部署、已知问题。想了解"整个后端怎么回事"看这份。 |
| api/ | API 接口文档(目录),采用"索引 + 一接口一文件",结构见下。想查"某个接口的协议"看这里。 |
| integrations/ | 集成层实现文档(目录):穿山甲验签 / 微信支付 / 极光 / 短信 / 美团 CPS 等 SDK 集成的签名、加解密、协议细节与踩坑。想知道"接外部服务那块到底怎么实现"看这里。 |
| 数据库迁移.md | Alembic 迁移指南:clone 后如何建表、日常升级、新增迁移、迁移文件命名约定。想"把数据库跑起来 / 改表结构"看这份。 |
| 待办与技术债.md | 待办与技术债账本:记"现在先简化、以后要补"的事 + 跨前后端技术债(P1 鉴权/用户绑定、引擎移植待办等),免遗忘。想知道"还欠什么、以后要补什么"看这份。 |
| 看广告赚金币上线清单.md | 看广告发奖上线 checklist:跨前后端,记上线前必做(GroMore 回调配置、清理调试脚手架、端到端验收)。上线"看广告赚金币"前对照这份。 |
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总览表里补一行链接。这样索引始终是唯一的"传送门",细节各自独立、互不干扰。