如何复制使用

这是什么

本书是酷可上编写「产品 HTTP API 文档」的通用模板：一端点一页，章按资源分，样式用甲·浅底方章（.cb-api-*）。系统平台 API 仍在 /api/docs，请勿把产品接口写进那个地址。

最快开写

• 新建一书（或复制本书，若站点开放复制）。
• 建概述页：粘贴「开始使用」骨架（Base URL / 鉴权 / 错误 / 限流）。
• 按资源建章；每接口一页，源码模式粘贴端点骨架，改方法、路径、参数表与 curl/fetch。
• 类名表与禁止事项见站内 SPEC（或本书附件/链到内部文档）。

必须遵守

• 一端点一页；试调只保留 curl / fetch 文本。
• 不要嵌入 Scalar、Swagger、Redoc 或自建试调表单。
• 方法徽章用 cb-api-method--get|post|put|patch|delete，不要用系统 /api/docs 的彩色 api-method。

以后

OAS → 书页自动生成会对齐同一 HTML；编辑器「插入 API 块」为后续增强。当前以粘贴骨架为准。

参考

• 端点示例页：本章「获取小部件」
• 现网甲案 demo（可选）：/books/cocobook-api-jia-pre/page/listusers-get-users
• 平台 API：/api/docs（标注：BookStack 平台，非本模板）