AI Skill 大全

代码生成API文档

扫描后端源码中的路由与控制器,自动提取请求参数、数据结构及鉴权要求,快速生成Markdown文档或OpenAPI规范。

功能与用途

专为后端开发与接口维护设计的文档生成工具。通过分析 Express、FastAPI 等主流框架的路由定义与控制器代码,自动识别 HTTP 方法、路径、请求体与返回结构,一键生成格式规范的 Markdown 接口清单或符合 OpenAPI 3.0 标准的 YAML 文件,大幅减少手动编写 API 接口文档的时间与维护成本。

适用场景

  • 生成Markdown接口文档:自动扫描路由与控制器定义,输出结构规范的 Markdown 格式接口说明供团队协作查阅。
  • 导出OpenAPI规范:将现有后端代码中的端点转换为 OpenAPI 3.0 YAML 文件,便于导入 Postman 或 Swagger UI。
  • 旧项目接口盘点:针对缺乏文档的遗留系统,快速分析路由和处理函数,生成完整的接口目录与参数说明。

适用人群

  • 后端开发工程师
  • 全栈开发工程师
  • 技术文档工程师
  • 系统架构师

使用步骤

  1. 指定待分析的后端源码目录或路由代码文件
  2. 选择所需输出格式(Markdown 或 OpenAPI 3.0)
  3. 自动扫描路由并提取参数、返回结构与鉴权要求
  4. 预览并导出结构化的 API 文档或规范文件

开始使用

将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。

查看 MCP 接入说明

技术信息

分类
编程
适用工具
Codex、Claude Code、OpenClaw、Hermes Agent、国内 Agent
使用难度
简单
版本
main
最近更新
2026-09-30
文件数
4
安装包大小
自动生成 ZIP
安全检查
基础检查通过

Generate API documentation from code. Use when the user wants to document APIs, create API reference, generate endpoint documentation, or needs help with OpenAPI/Swagger specs.

同类 Skill