docs: reorganize api docs into categorized subdirectories and fill missing docs

- Categorize 77 existing api docs into 16 business-domain subdirectories
  (auth/ad/wallet/coupon/compare/savings/signin/tasks/invite/user/
   device/platform/intent/meituan/other) plus admin/ and internal/
- Split admin/ into 7 sub-resource subdirectories (auth/users/wallet/
  withdraws/feedbacks/admins/ad) with 4 single-file docs at root
- Create 21 new docs covering 28 previously undocumented endpoints:
  ad/watch-report, wallet/transfer-auth (3 endpoints), coupon/session+
  stats+completed-today+prompt (7), invite/me+invitees+bind+landing-track,
  user/onboarding (2), platform/flags+ad-config+app-version,
  intent/step+precoupon/step, analytics/events, order/report,
  report/submit+records, feedback/config+records, trace/finalize
- Add mock request/response JSON examples to all new docs
- Create docs/README.md with full category index for LLM navigation
- Update docs/api/README.md: fix all links, add new endpoint rows,
  replace "no doc" markers with actual links
- Fix back-navigation links (./README.md -> ../README.md or
  ../../README.md) in all moved files
@
This commit is contained in:
guke
2026-07-03 14:56:50 +08:00
parent ee132aa93b
commit b23335d5fb
102 changed files with 2418 additions and 217 deletions
+39
View File
@@ -0,0 +1,39 @@
# GET /api/v1/platform/app-version — 最新 App 版本
> 所属:Platform 组(前缀 `/api/v1/platform` | 鉴权:无 | [← 返回 API 索引](../README.md)
客户端启动 / 手动检查更新时拉取。用 `latest_version_code` 与本机 `versionCode` 比;未配置(返回默认 0)时客户端视为已是最新。
## 入参
无。
## 出参
响应 `200`:`AppVersionOut`
| 字段 | 类型 | 说明 |
|---|---|---|
| `latest_version_code` | int | 最新版 versionCode0 = 未配置(无更新) |
| `latest_version_name` | string | 展示用版本号(如 `0.1.4` |
| `apk_url` | string | 下载链接(发车产出的永久版本化链接) |
| `update_note` | string | 更新说明,弹窗展示(如「修复了部分机型闪退问题」) |
| `min_supported_version_code` | int | 本机低于此版本 = 强制更新;0 = 不强更(全可选) |
| `apk_size_bytes` | int | 包大小(字节),展示「约 x MB」 |
Mock 出参:
```json
{
"latest_version_code": 42,
"latest_version_name": "0.1.5",
"apk_url": "https://cdn.shaguabijia.com/releases/app-v0.1.5.apk",
"update_note": "1. 修复了部分机型闪退问题\n2. 优化了比价速度\n3. 新增省钱大作战功能",
"min_supported_version_code": 35,
"apk_size_bytes": 18350080
}
```
## 说明
- 不鉴权(版本信息非敏感,检查更新可能在登录前)
- `latest_version_code = 0` → 无更新,客户端无需提示
- `min_supported_version_code > 本机 versionCode` → 强制更新弹窗(不可跳过)