Token导航 LogoToken导航TokenDH.com
中转站排行榜
开发需要联网clawhub未标认证来源可访问clear审计通过

api-design-doc（API 设计 DOC）

Agent Skill

用于辅助 API 设计、接口文档、请求响应结构和服务集成说明。它适合让 Agent 梳理 endpoint、生成 OpenAPI 草稿、检查字段命名、整理错误码或辅助前后端联调。使用时需要确认真实业务语义、鉴权方式、分页和错误处理规则；涉及生成接口文档时，应避免凭空补字段，最好从现有代码、schema 或接口样例中提取事实。

总安装

7,728

周安装

322

GitHub Stars

公开资料未说明

下载量

2,576
OpenClaw

安装说明

本站只整理中文说明和来源信息，不托管安装包，也不代用户安装。

GitHub

来源数

2

许可证

MIT-0

最后核验

2026-05-01

来源状态

来源可访问

安装方式

通过对话安装

复制提示词发给支持本地命令或 Skills 的 AI 助手，先确认命令和权限，再让它执行。

请帮我安装这个 Agent Skill：api-design-doc（API 设计 DOC）
来源仓库：https://github.com/cnsunxuefeng/api-design-doc
安装命令：
openclaw skills install api-design-doc
安装前请先检查当前环境是否支持对应 CLI，并向我确认将要执行的命令、安装目录、联网范围和文件读写权限；确认后再执行。

命令行安装

复制命令到本机终端执行。该命令会通过 OpenClaw 从第三方来源获取 Skill；本站只展示命令，不托管安装包，也不自动执行。

ClawHubOpenClaw
openclaw skills install api-design-doc

简介

API Design Doc 标准化生成 RESTful API 接口设计文档。

  • 支持从需求文档或数据库 DDL 自动生成规范。
  • 包含错误码、入参出参定义和 JSON 示例。
  • 适合指导前后端联调和代码开发阶段使用。api-design-doc 属于开发类 Skill，可作为该场景下的辅助能力补充。
  • 建议结合业务实际调整字段命名和校验规则。

SKILL.md

name
API-design-doc
description
标准化API接口设计文档生成工具。根据需求文档、数据库DDL等输入，进行API的标准化、规范化设计，输出完整的API接口设计文档，包括错误码规范、接口格式规范、入参出参定义、JSON示例等，指导后续的代码开发和前后端联调。使用场景包括：(1) 根据业务需求设计RESTful API接口，(2) 基于数据库DDL生成对应的CRUD接口文档，(3) 规范化现有API接口文档，(4) 为前后端联调提供标准化的接口规范文档

API Design Doc

根据需求文档、数据库DDL等输入，生成标准化的API接口设计文档。

工作流程

  1. 收集输入信息

- 获取需求文档或业务需求描述 - 获取数据库DDL（如果适用） - 明确接口的业务场景和功能需求

  1. 页面功能与API接口关系

- 明确页面功能与API接口的对应关系

  1. 设计API接口

- 确定接口的RESTful风格（GET/POST/PUT/DELETE） - 定义接口URL路径 - 设计入参和出参结构 - 选择合适的错误码

  1. 生成接口文档

- 使用标准模板生成每个接口的详细文档 - 包含功能描述、入参、出参、URL、请求方式、JSON示例

  1. 输出完整文档

- 页面功能与API接口关系 - 汇总所有接口文档 - 包含错误码规范总表 - 提供接口格式规范说明

参考资料

错误码规范

参见 error-codes.md - 完整的错误码列表和说明

接口文档模板

参见 api-spec-template.md - 标准的API接口文档格式

命名规范

参见 naming-conventions.md - API命名和参数命名规范

最佳实践

参见 best-practices.md - API设计最佳实践

模板文件

API文档模板

使用 templates/api-doc-template.md 作为单个接口文档的模板

API响应模板

使用 templates/api-response-template.json 作为标准响应格式参考

使用指南

当用户请求设计API接口时：

  1. 首先读取 error-codes.md 了解错误码规范
  2. 根据业务需求设计接口，参考 best-practices.md
  3. 使用 api-spec-template.md 的格式生成每个接口文档
  4. 确保命名符合 naming-conventions.md 的规范
  5. 输出完整的API设计文档，包含所有接口和错误码总表

输出格式

接口文档必须包含以下部分：

  1. 错误码规范总表
  2. 接口格式规范说明
  3. 页面功能与API接口关系表，包含以下内容：

- 页面名称：前端页面或功能模块的名称 - 页面功能描述：页面或功能模块的简要说明 - 关联API接口：该页面调用的API接口列表（API-Id） - 操作类型：GET/POST/PUT/DELETE等HTTP方法 - 接口URL：完整的API路径

  1. 接口清单与详细定义，详细定义的规范如下：
  • 接口编号（API-Id）：顺序生成，格式为 API001-接口名称，如 API001-用户登录, API002-获取用户列表, ...
  • 功能描述：详细描述接口的功能和用途
  • 入参：参数类型和说明（标注必填/可选）
  • 返回参数：返回值类型和说明
  • URL地址：完整的API路径
  • 请求方式：GET/POST/PUT/DELETE
  • 接口 JSON 示例：完整的请求和响应JSON示例

输出位置

  • 仅生成一份API文档，保存在项目根目录下的 doc/ 目录。
  • 若 doc/ 目录不存在，应自动创建该目录后再写入文档。
  • 文档文件名固定为：API接口设计文档.md，内容包含：
  • 错误码总表（来自 references/error-codes.md）
  • 接口格式规范（来自 references/api-spec-template.md 的说明部分）
  • 页面功能与API接口关系表（按页面或功能模块归类）
  • 接口清单与详细定义（按模块归类的所有接口条目）

适合场景

01

OpenClaw 用户查找和安装 Skill 时

02

用户想查找某类 Agent Skill 时

03

需要根据任务场景推荐可安装能力包时

04

需要对比不同来源的安装命令和来源信息时

能力概览

能力 1

按任务关键词查找相关 Skills

能力 2

展示可复制的安装命令

能力 3

保留来源站点、仓库和原始说明，方便继续核验

能力 4

补充不同宿主或平台的使用分布数据

能力 5

展示第三方安全扫描或审计结果

安装后应在对应宿主中按原始 README 的触发条件使用；具体调用方式请以来源页面和 README 为准。

平台分布

OpenClaw

96.96%
按下载量换算2,498

安全审计

VirusTotal

通过

ClawScan

通过

Static analysis

通过

权限和风险

需要联网

该 Skill 可能需要联网访问来源站点、仓库或外部 API；具体网络访问范围需要结合源码和 README 复核。

安装前确认

本站仅展示第三方公开信息，不托管安装包，不提供自动安装或运行环境。安装前应自行审查源码、依赖和命令行为。当前只有一个来源，正式发布前建议补源仓库或其他目录站核验。

来源信息

GitHub 仓库

github.com

/cnsunxuefeng/api-design-doc

SKILL.md 来源

clawhub.ai

/cnsunxuefeng/api-design-doc

继续浏览同类 Skills

更多开发 Skills（21,746）返回 Skills 目录

上一个 Skill

api-design（API 设计）

用于辅助 API 设计、接口文档、请求响应结构和服务集成说明。它适合让 Agent 梳理 endpoint、生成 OpenAPI 草稿、检查字段命名、整理错误码或辅助前后端联调。使用时需要确认真实业务语义、鉴权方式、分页和错误处理规则；涉及生成接口文档时，应避免凭空补字段，最好从现有代码、schema 或接口样例中提取事实。

下一个 Skill

api-design-framework（API 设计 framework）

用于辅助 API 设计、接口文档、请求响应结构和服务集成说明。它适合让 Agent 梳理 endpoint、生成 OpenAPI 草稿、检查字段命名、整理错误码或辅助前后端联调。使用时需要确认真实业务语义、鉴权方式、分页和错误处理规则；涉及生成接口文档时，应避免凭空补字段，最好从现有代码、schema 或接口样例中提取事实。