collectionDoc.ts 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. /**
  2. * 《收付款 OpenAPI 接入文档》的侧边栏条目定义(正文 `docs/collection-openapi.md`)。
  3. *
  4. * 切片逻辑在 `docSlicer.ts`,本文件只写「哪些标题拼成哪一条」。
  5. * 另一条通道(门店与订单)是独立产品、独立文档,见 `harDoc.ts` 与 `docs/har-openapi.md`。
  6. */
  7. import raw from "./docs/collection-openapi.md?raw";
  8. import { buildSections, type DocSectionDef } from "./docSlicer";
  9. /**
  10. * 侧边栏条目定义。键即 `activeSection` 的值。
  11. * `parts` 里的标题必须与 md 里的标题**逐字一致**(含空格、全角括号)。
  12. */
  13. const SECTIONS: DocSectionDef[] = [
  14. {
  15. key: "collection_intro",
  16. title: "接入总则",
  17. parts: ["## 1. 概述", "## 2. 接入准备", "## 3. 请求约定", "## 4. 业务约定"],
  18. },
  19. { key: "collection_barcode", title: "付款码支付", parts: ["### 5.1 付款码支付(被扫)"] },
  20. { key: "collection_qrcode", title: "二维码支付", parts: ["### 5.2 二维码支付(主扫)"] },
  21. { key: "collection_h5", title: "H5 支付", parts: ["### 5.3 H5 支付"] },
  22. { key: "collection_order_query", title: "订单查询", parts: ["### 5.4 订单查询"] },
  23. { key: "collection_close", title: "撤销关单", parts: ["### 5.5 撤销 / 关单"] },
  24. { key: "collection_refund", title: "发起退款", parts: ["### 5.6 退款"] },
  25. { key: "collection_refund_query", title: "退款查询", parts: ["### 5.7 退款查询"] },
  26. {
  27. key: "collection_status",
  28. title: "状态与通知",
  29. parts: ["## 6. 状态说明", "## 7. 异步通知(回调)"],
  30. },
  31. {
  32. key: "collection_checklist",
  33. title: "联调与常见问题",
  34. parts: ["## 8. 联调检查清单", "## 9. 常见问题"],
  35. },
  36. ];
  37. export const collectionSections = buildSections(raw, SECTIONS);