Files

T

marco a07361007f docs: 新增 docs/README.md 文档库导航(说明 api/ 传送门结构)

- docs/README.md: 说明文档库结构(后端技术实现.md + api/), 重点讲 api/ 的
  "索引 + 一接口一文件"传送门组织方式, 及新增接口时的维护约定

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

2026-05-27 12:13:58 +08:00

1.6 KiB

Raw Blame History

后端文档库(docs/)

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

文档 / 目录	作用
后端技术实现.md	后端技术方案:业务概览、分层架构与目录、登录链路、美团 CPS、领券透传、数据模型、配置与部署、已知问题。想了解"整个后端怎么回事"看这份。
api/	API 接口文档(目录),采用"索引 + 一接口一文件",结构见下。想查"某个接口的协议"看这里。

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 总览表里补一行链接。这样索引始终是唯一的"传送门",细节各自独立、互不干扰。

1.6 KiB Raw Blame History

后端文档库(docs/)

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

1.6 KiB

Raw Blame History