api-doc-generator
自动从代码生成API文档，提升开发效率
安装使用
复制下面这段提示词发给你的 AI（Claude / Cursor / TRAE / Codex / WorkBuddy 等），它会自动帮你完成安装：
帮我安装这个 AI Skill：api-doc-generator。 它的用途是：自动从代码生成API文档，提升开发效率 详细介绍见：https://321skill.com/skills/api-doc-generator/ 请根据该页面的说明完成安装。
使用示例
'请为我分析`/src/routes/user.js`这个文件里的API接口，并生成一份API文档。'，它会自动解析该路由文件，识别出所有的GET、POST等端点，提取请求参数和响应示例，生成一份结构清晰的Markdown文档。或者你可以说：'基于当前项目，为所有用户管理相关的接口生成文档摘要。'，它会扫描相关模块，汇总生成一份聚焦于用户管理的API文档。
介绍
这个Skill解决了开发者在项目开发或维护时，手动编写和更新API文档耗时耗力、容易与代码脱节的问题。它能够自动分析你的代码库，提取接口、参数、返回值等信息，并生成结构清晰、格式规范的API文档。
使用方式非常简单，你只需要在AI对话中提供你的代码仓库路径或直接粘贴相关代码片段，然后指示它生成API文档。它会自动解析代码结构，识别出API端点、请求方法、参数类型和响应格式，最终输出一份可读性强的文档。
这个Skill非常适合后端开发、全栈开发和文档工程师，特别是那些需要频繁维护API接口、与前端或第三方团队协作，或者追求开发流程自动化的开发者。它帮助你将精力集中在核心业务逻辑上，而不是繁琐的文档工作上。
建议在代码结构相对清晰、注释规范的项目中使用，效果最佳。对于高度动态生成或注释严重缺失的代码，可能需要先进行一些整理。生成的文档可以作为基础，建议再根据实际业务逻辑进行补充和润色。
核心特点
与同类工具相比，它深度集成在AI对话中，无需离开开发环境或配置复杂的命令行工具，通过自然语言指令即可快速生成文档；同时，它能理解代码上下文，而不仅仅是解析语法，生成的文档更具可读性和业务相关性。
注意事项
对于注释极少、依赖运行时动态生成或结构非常复杂的代码，自动生成的文档可能不够完整或准确。
常见问题
支持哪些编程语言？
主要支持常见的后端语言如Python、JavaScript/TypeScript、Go、Java等，能识别主流Web框架的API定义。
生成的文档是什么格式？
通常生成Markdown格式的文档，清晰易读，也方便你后续导入到Confluence、GitHub Wiki等平台。