泰国地区 API 文档 — 编写与展示规范(维护说明)
泰国地区 API 文档 — 编写与展示规范(维护说明)
面向维护者:编辑 docs/**/reference/thailand/** 下内容时,请按本文与 英文 Pay-In 范本 对齐,并与 印尼地区规范 共用同一套 VuePress 增强(client、样式)。
一、与印尼的差异(路径与业务)
| 项 | 泰国 | 印尼 |
|---|---|---|
| 支付方式文档路径 | 根目录 paymentMethod.md(无 method/ 子目录) | method/paymentMethod.md |
从 transaction/、inquiry/ 链到支付方式 | ../paymentMethod.md | ../method/paymentMethod.md |
| 账户查询 | 无 inquiryAccount 页 | 有 inquiryAccount |
| 币种 / Pay-in 通道 | THB;请求里 paymentMethod 为 QRPAY 或 KBANK(以接口页为准) | IDR;多通道见印尼支付方式表 |
不得因版式重写删除:payer(含 name、accountNo、bankName)、THB、QRPAY/KBANK 等与现网一致的业务说明(金额上下限以产品为准时可不在正文写死)。
二、全局能力
与 印尼规范 · 第二节 相同:四列表增强、支付方式三列表、apifox-endpoint-bar 样式等。
三、HTTP 接口页(transaction/、inquiry/)
范本:docs/en/reference/thailand/transaction/payin.md。应对齐的文件:payin、payout、inquiryBalance、inquiryStatus(各语言同路径)。
3.1 文首与 Endpoint
- Frontmatter 后先写短说明(泰国场景、THB、关键支付方式等),再
### Request。 apifox-endpoint-bar紧接在### Request下、#### Request Path:上;path 使用文档中的真实相对路径(如/v2.0/transaction/pay-in),勿从印尼页照抄业务 path。
3.2 章节顺序与四列表
与印尼文档 第三节 3.3–3.4、3.4 一致:### Responses(复数)、Field 列反引号、Required 为 M/O/C、示例 tabs 的 @tab Header 仅请求头等。
3.3 链接深度
从 docs/{locale}/reference/thailand/transaction/ 或 inquiry/ 到产品文档:../../../product/...;到支付方式:../paymentMethod.md。状态查询页内链到支付方式时写 ../paymentMethod.md(不要写 ../method/paymentMethod.md)。
3.4 回调章节标题
与印尼对齐时使用 ### Notification/Callback;返回体说明使用 :::info(小写 info)。
四、侧栏标题(title)
建议使用可读短标题(如 Pay-in collection、Disbursement (pay-out)、Balance inquiry、Transaction status),避免 API PAYIN 类全大写。
五、支付方式页(paymentMethod.md)
- 三列表:英文
Method | Type | Description;中文方式 | 类型 | 描述;泰文วิธี | ประเภท | คำอธิบาย。 - Supported 小节:说明 Method 列 = 请求中的
paymentMethod(泰国页不放置 Logo 图)。 - Pay-In / Pay-Out 描述建议各约两行(
<br>),与印尼页风格一致。 - 批量压短 Pay-Out 描述时,可对泰国路径执行:
node scripts/shorten-payout-descriptions.mjs docs/en/reference/thailand/paymentMethod.md
(脚本识别 ## Pay-Out 等标题;若表内已是两行 <br> 格式则会跳过。)
六、适用范围与例外
| 路径 | 建议 |
|---|---|
transaction/payin.md、payout.md | 按第三节全文。 |
inquiry/inquiryBalance.md、inquiry/inquiryStatus.md | 同上。 |
paymentMethod.md | 按第五节。 |
settlement/*.md、README.md | 叙述为主,不强制 endpoint 条与四列表。 |
