·api-doc-generator
#

api-doc-generator

teachingai/agent-skills

通过扫描代码接口、提取请求/响应来生成 API 文档提供全面的指导 信息,并创建标准化 API 文档。仅当用户明确提及生成 API 时使用 文档、创建 API 文档、扫描接口或记录 API。该技能扫描控制器类,提取 接口信息(URL、方法、参数、响应),并按照标准模板生成文档。 如果没有明确提及 API 文档,请勿触发通用文档请求。

5安装·0热度·@teachingai

安装

$npx skills add https://github.com/teachingai/agent-skills --skill api-doc-generator

SKILL.md

CRITICAL: This skill should ONLY be triggered when the user explicitly mentions generating API documentation, creating API docs, scanning interfaces, or documenting APIs.

CRITICAL: This skill should ONLY be triggered when the user explicitly mentions generating API documentation. Do NOT trigger for generic documentation requests without API context.

CRITICAL: Before generating any documentation, you MUST scan the code to find API interfaces.

通过扫描代码接口、提取请求/响应来生成 API 文档提供全面的指导 信息,并创建标准化 API 文档。仅当用户明确提及生成 API 时使用 文档、创建 API 文档、扫描接口或记录 API。该技能扫描控制器类,提取 接口信息(URL、方法、参数、响应),并按照标准模板生成文档。 如果没有明确提及 API 文档,请勿触发通用文档请求。 来源:teachingai/agent-skills。

查看原文

可引用信息

为搜索与 AI 引用准备的稳定字段与命令。

安装命令
npx skills add https://github.com/teachingai/agent-skills --skill api-doc-generator
分类
#文档处理
认证
收录时间
2026-02-01
更新时间
2026-02-18

快速解答

什么是 api-doc-generator?

通过扫描代码接口、提取请求/响应来生成 API 文档提供全面的指导 信息,并创建标准化 API 文档。仅当用户明确提及生成 API 时使用 文档、创建 API 文档、扫描接口或记录 API。该技能扫描控制器类,提取 接口信息(URL、方法、参数、响应),并按照标准模板生成文档。 如果没有明确提及 API 文档,请勿触发通用文档请求。 来源:teachingai/agent-skills。

如何安装 api-doc-generator?

打开你的终端或命令行工具(如 Terminal、iTerm、Windows Terminal 等) 复制并运行以下命令:npx skills add https://github.com/teachingai/agent-skills --skill api-doc-generator 安装完成后,技能将自动配置到你的 AI 编程环境中,可以在 Claude Code 或 Cursor 中使用

这个 Skill 的源码在哪?

https://github.com/teachingai/agent-skills

详情

分类
#文档处理
来源
skills.sh
收录时间
2026-02-01