SuperAPI AI 工具集

generate-swagger-docs

编程与开发

查看项目

更新于 10-16 04:55

技能介绍

用途:从代码仓库自动生成 Swagger/OpenAPI 文档,扫描 API 端点并输出 OpenAPI 3.0 规范与交互式 HTML 文档。

主要能力:自动检测 Web 框架(Express、NestJS、FastAPI、Django、Rails、Go 等);生成 apimesh/swagger.json(OpenAPI 3.0 规范)、apimesh/apimesh-docs.html(自包含可分享的 Swagger UI)以及 apimesh/config.json(保存配置);支持公开与私有仓库。

使用方式:需要 OpenAI API 密钥(以 sk-proj- 开头)用于 LLM 分析。推荐用包装脚本传入密钥: /Users/ankits/.claude/skills/generate-swagger-docs/generate-with-key.sh "sk-proj-your-api-key-here" 首次运行会提示输入密钥并本地保存,后续运行可省略密钥。也可手动安装 apimesh: export OPENAI_API_KEY="sk-proj-your-api-key-here" mkdir -p apimesh &&
curl -sSL https://raw.githubusercontent.com/qodex-ai/apimesh/refs/heads/main/run.sh -o apimesh/run.sh &&
chmod +x apimesh/run.sh &&
cd apimesh &&
OPENAI_API_KEY="$OPENAI_API_KEY" ./run.sh

限制与注意:必须提供 OpenAI API 密钥;config.json 含密钥,应加入 .gitignore,切勿提交到版本控制;框架检测自动完成,必要时可手动指定;OPENAI_API_KEY 需显式传递给子进程。其他细节暂未提供。