跳转到主要内容

书籍

API Doc Template

可复制的 API 文档写法模板（阅读壳 · 甲徽章）

1 章7 页更新于 23 小时前

开始阅读

目录7

  1. 01 How to copy 如何复制使用 这是什么 本书是酷可上编写「产品 HTTP API 文档」的通用模板：一端点一页，章按资源分，样式用甲·浅底方章（ .cb-api-*）。系统平台 API 仍在 /api/docs，请勿把... 21 小时前
  2. 02 Insert endpoint block 插入端点块 P0 写法：在编辑器里用源码 / HTML模式粘贴约定骨架，再改文案。编辑器「插入 API 块」按钮是后续增强，当前不依赖。 步骤 新建页（建议页名： 动词 · 路径，一端点一页）。 编辑器... 22 小时前
  3. 03 Getting Started 开始使用 本文档说明如何调用本产品的 HTTP API。系统 BookStack 平台 API 请另见 /api/docs（与本书无关）。 Base URL 所有路径均相对于下方根地址（... 23 小时前
  4. 第 1 章 Widgets 4 页
    1. 1.1 List widgets 列出小部件 GET /v1/widgets operationId: listWidgets · 分组: Widgets · 鉴权: Bearer Token 分页列出小... 21 小时前
    2. 1.2 Get widget 获取小部件 GET /v1/widgets/ id operationId: getWidget · 分组: Widgets · 鉴权: Bearer Token 按 I... 23 小时前
    3. 1.3 Create widget 创建小部件 POST /v1/widgets operationId: createWidget · 分组: Widgets · 鉴权: Bearer Token 创建小... 21 小时前
    4. 1.4 Delete widget 删除小部件 DELETE /v1/widgets/ id operationId: deleteWidget · 分组: Widgets · 鉴权: Bearer Token ... 21 小时前