fastapi-api-docs-skills
自动分析FastAPI路由并生成完整的API文档元数据。
安装使用
复制下面这段提示词发给你的 AI（Claude / Cursor / TRAE / Codex / WorkBuddy 等），它会自动帮你完成安装：
帮我安装这个 AI Skill：fastapi-api-docs-skills。 它的用途是：自动分析FastAPI路由并生成完整的API文档元数据。 完整的 Skill 内容见：https://321skill.com/skills/fastapi-api-docs-skills/raw/index.md 请读取该页面内容，如果是 SKILL.md 格式直接安装，如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接，AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
‘/api-docs @./src/api/user_routes.py’，它会自动分析该文件中的所有FastAPI路由，追踪`Depends`依赖和内部错误，并为你生成完整的OpenAPI格式的文档描述。你也可以说：‘/api-docs @./src/api/’，让它批量处理整个目录下的所有路由文件。
介绍
这个Skill旨在解决FastAPI项目中文档编写繁琐且易遗漏的问题。它通过分析路由文件，自动追踪依赖关系、错误传播和业务逻辑，生成符合OpenAPI规范的文档元素，如摘要、描述和参数说明。
使用时，只需在AI对话中提供目标FastAPI路由文件的路径，Skill便会自动解析并生成文档。支持单文件、多文件或整个目录的批量处理模式，能显著提升文档编写的覆盖率和一致性。
它非常适合后端开发、全栈开发和文档工程师等角色，尤其适合那些需要维护大量API接口、追求文档与代码同步更新的团队或个人开发者。
建议在项目开发中期或重构阶段使用，以便一次性为现有代码补充文档。注意，它主要分析代码结构生成元数据，对于业务逻辑的详细描述仍需人工润色和确认。
核心特点
与同类文档生成工具相比，它能深度追踪FastAPI特有的`Depends`依赖链，并分析路由处理函数内部可能的错误传播路径，从而生成包含认证、错误码等更全面的API文档元数据，而非简单的函数签名提取。
注意事项
不适合为未使用FastAPI框架或代码结构极其不规范（如大量动态生成路由）的项目生成文档。
常见问题
它能处理使用了Pydantic模型的FastAPI项目吗？
可以，它能识别路由参数和响应中的Pydantic模型，并将其信息整合到生成的OpenAPI文档中。
生成的文档可以直接用于生产环境吗？
生成的文档元数据（如summary, description）是高质量的起点，但建议根据实际业务逻辑进行最终的人工审查和润色。
给 AI 助手的安装指引
如果你的 AI 编程助手（Claude Code、Cursor、TRAE 等）能看到这个页面，把下面这段发给它即可自动完成安装：
请访问 https://321skill.com/skills/fastapi-api-docs-skills/raw/index.md 读取 fastapi-api-docs-skills 的原始 Skill 定义（Markdown 格式），按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址：/skills/fastapi-api-docs-skills/raw/index.md（查看排版版本）