Files
shaguabijia-app-server/docs
OuYingJun1024 0722d7b0d5 feat: 福利钱包+签到+省钱战绩+激励广告发奖+微信提现 后端
- 福利钱包: 金币/现金余额、流水、兑换 (api/v1/wallet.py, crud/wallet.py, models/wallet.py, schemas/welfare.py)
- 每日签到: 连续天数 + 档位奖励 (api/v1/signin.py, crud/signin.py, models/signin.py)
- 任务系统: "打开消息提醒"等任务领奖 (api/v1/tasks.py, crud/task.py, models/task.py)
- 省钱战绩: 省钱汇总/战绩/店铺菜品 (api/v1/savings.py, crud/savings.py, models/savings.py)
- 激励广告发奖: 穿山甲服务端回调 + 发奖规则 + 限流 (api/v1/ad.py, core/pangle.py, core/rewards.py, core/ratelimit.py, crud/ad_reward.py, schemas/ad.py, docs/ad_reward_golive_checklist.md)
- 微信提现: 商家转账到零钱 V3 (core/wxpay.py); user 表加微信 openid/nickname/avatar
- DB 迁移: 8 个 alembic (welfare 表/cash_transaction/openid 唯一约束/savings 店铺菜品/savings_record/ad_reward/withdraw_order+openid/user 微信字段)
- 运维脚本: reconcile_withdraws(对账) + reset_signin/reset_welfare + sim_pangle_callback(模拟穿山甲回调)
- 测试: test_welfare / test_withdraw / test_ad_reward
- 配置: .env.example + config.py 新增福利/广告/微信支付项; main.py 挂 5 个新路由

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-27 17:38:08 +08:00
..
2026-05-27 12:26:58 +08:00

后端文档库(docs/)

shaguabijia-app-server 的文档都在这里。各文档作用:

文档 / 目录 作用
后端技术实现.md 后端技术方案:业务概览、分层架构与目录、登录链路、美团 CPS、领券透传、数据模型、配置与部署、已知问题。想了解"整个后端怎么回事"看这份。
api/ API 接口文档(目录),采用"索引 + 一接口一文件",结构见下。想查"某个接口的协议"看这里。
待办与技术债.md 待办与技术债账本:记"现在先简化、以后要补"的事 + 跨前后端技术债(P1 鉴权/用户绑定、引擎移植待办等),免遗忘。想知道"还欠什么、以后要补什么"看这份。

api/ 目录是怎么组织的(传送门式)

接口多了之后,单个大文件会臃肿、难维护,所以拆成 一个索引 + 一个接口一个文件:

  • api/README.md — 入口/传送门 一张总览表列出全部接口(方法、路径、鉴权),每行链接到该接口的独立文档;另含通用约定(错误码、时间格式等)和复用数据结构(TokenPair / UserOut / CouponCard 等)。它本身不展开每个接口的细节,只负责"指路"。
  • api/<模块>-<接口>.md — 单接口文档 每个接口一个文件,只写自己的入参 / 出参 / 错误码 / 说明。命名按 <模块>-<接口>,如 auth-jverify-login.mdcoupon-step.mdmeituan-feed.md

查某个接口的协议:先打开 api/README.md 的总览表 → 找到接口 → 点链接进对应文档。

新增接口时:在 api/ 下加一个 <模块>-<接口>.md,并到 api/README.md 总览表里补一行链接。这样索引始终是唯一的"传送门",细节各自独立、互不干扰。