OuYingJun1024
3d1e8969e6
- 新增 docs/integrations/(README + jiguang/sms/meituan/pangle/wxpay 各一篇): 记录各 SDK 集成的签名/验签/加解密/协议细节与踩坑(对齐 app/integrations 分层) - docs/api 接口文档变薄: 受影响接口头部加「集成实现」链接,把验签/RSA/CPS 签名 等重逻辑描述移到集成文档;ad-pangle-callback 验签段精简为指针 - docs/api/README 补架构说明(api 薄 / 重逻辑在 integrations) - 后端技术实现.md 目录树补全(福利/钱包/签到/省钱/发奖端点 + crud/integrations 现状), pangle/wxpay 标注移入 integrations - ad_reward_golive_checklist 路径同步 core→integrations Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
后端文档库(docs/)
shaguabijia-app-server 的文档都在这里。各文档作用:
| 文档 / 目录 | 作用 |
|---|---|
| 后端技术实现.md | 后端技术方案:业务概览、分层架构与目录、登录链路、美团 CPS、领券透传、数据模型、配置与部署、已知问题。想了解"整个后端怎么回事"看这份。 |
| api/ | API 接口文档(目录),采用"索引 + 一接口一文件",结构见下。想查"某个接口的协议"看这里。 |
| 待办与技术债.md | 待办与技术债账本:记"现在先简化、以后要补"的事 + 跨前后端技术债(P1 鉴权/用户绑定、引擎移植待办等),免遗忘。想知道"还欠什么、以后要补什么"看这份。 |
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总览表里补一行链接。这样索引始终是唯一的"传送门",细节各自独立、互不干扰。