haomingz/kimi-skills/api-doc-gen

Claude Code and agent skill by haomingz/kimi-skills

Trust tier 3
  • community
Source check pending

Checking that the SKILL.md file is still in the repository.

从 Flask、FastAPI、Express 或 Gin 等 Web 框架的源代码中自动扫描路由定义,生成符合 OpenAPI 3.0 / Swagger 规范的标准化 API 文档文件。当用户需要生成 API 文档、提到 OpenAPI、Swagger、接口文档、路由扫描或从代码自动提取接口信息时触发。

Install

npx vskill@latest install haomingz/kimi-skills/api-doc-gen

SKILL.md

The same SKILL.md was published earlier as serejaris/kimi-skills/api-doc-gen.

api-doc-generator

从源代码中的路由/端点定义自动扫描并生成符合 OpenAPI 3.0.3 规范的 RESTful API 文档。

支持主流 Web 框架,自动检测框架类型,提取 HTTP 方法、路径、参数、请求体、响应模型和文档注释,输出可直接导入 Swagger UI / Redoc 的标准 OpenAPI 规范文件。

Quick Start

bash
# 扫描源码目录,输出 JSON 格式 OpenAPI spec
python scripts/generate_api_doc.py ./src
# 指定输出格式和文件
python scripts/generate_api_doc.py ./src --format yaml --output api-spec.yaml
# 指定框架和 API 元信息
python scripts/generate_api_doc.py ./app --framework flask --title "My API" --version 2.0.0
# 添加服务器地址
python scripts/generate_api_doc.py ./routes --server http://localhost:3000 --server https://api.example.com

支持的框架

语言框架解析方式
PythonFlaskAST 解析(装饰器 + 类型注解 + docstring)
PythonFastAPIAST 解析(装饰器 + Pydantic 模型 + 类型注解)
PythonDjango REST FrameworkAST 解析(@api_view 装饰器)
JavaScript/TypeScriptExpress.js正则匹配(app.get() / router.get() + JSDoc)
GoGin正则匹配(r.GET() / group.GET() + 注释)
GoEcho正则匹配(e.GET() + 注释)

提取能力

脚本会自动提取以下信息:

  • HTTP 方法:GET / POST / PUT / DELETE / PATCH 等
  • 路由路径:自动转换各框架路径参数格式为 OpenAPI {param} 格式
  • 路径参数:从路由模式中提取(含类型推断)
  • 查询参数:从函数签名中提取(Python 框架)
  • 请求体:从类型注解和 Pydantic 模型中推断(FastAPI)
  • 响应模型:从 response_model 参数中提取(FastAPI)
  • 接口描述:从 docstring / JSDoc / 行注释中提取
  • 标签分组:按源文件模块名自动分组

路径参数格式转换

框架源格式转换结果
Flask<int:user_id>{user_id} (type: integer)
FastAPI{user_id}{user_id} (保持不变)
Express:user_id{user_id}
Gin/Echo:user_id{user_id}

参数说明

参数说明默认值
source_dir要扫描的源码目录(必填)-
-f, --format输出格式:json 或 yamljson
-o, --output输出文件路径stdout
--framework强制指定框架(不自动检测)自动检测
--titleAPI 文档标题API Documentation
--versionAPI 版本号1.0.0
--descriptionAPI 描述文字空
--server服务器地址(可多次指定)无

输出示例

json
{
"openapi": "3.0.3",
"info": {
"title": "My API",
"version": "1.0.0"
},
"paths": {
"/users": {
"get": {
"summary": "List all users",
"operationId": "list_users",
"tags": ["users"],
"parameters": [
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer" }
}
],
"responses": {
"200": { "description": "Successful response" }
}
}
},
"/users/{user_id}": {
"get": {
"summary": "Get user by ID",
"operationId": "get_user",
"tags": ["users"],
"parameters": [
{
"name": "user_id",
"in": "path",
"required": true,
"schema": { "type": "integer" }
}
],
"responses": {
"200": { "description": "Successful response" }
}
}
}
}
}

前置条件

  • Python 3.8+
  • 无需安装额外依赖,仅使用 Python 标准库
  • 被扫描的项目需使用上述支持的 Web 框架

Security

  • Security scanPassed, 90 of 100Pattern checks on the skill's files.
  • Model reviewPassed

Quality evaluation

  • Task evaluationNot runNo evaluation yet. Run one in Skill Studio.

Source

Popularity

7-day trend score
0

Not refreshed yet.

Works with

Any agent vskill installs to: 56 targets in all. These 39 have a page on this site.

  • Claude Code
  • Cursor
  • GitHub Copilot
  • Windsurf
  • Codex
  • Gemini CLI
  • Cline
  • Amp
  • Roo Code
  • Goose
  • Continue
  • Kilo Code
  • Junie
  • Trae
  • OpenHands
  • Qwen Code
  • AI Agent
  • Tabnine Chat
  • Sourcegraph Cody
  • Amazon Q
  • Firebase Genkit
  • Sweep
  • Devin
  • Phind
  • Mentat
  • Claude Desktop
  • Aider
  • GPT Pilot
  • Plandex
  • bolt.new
  • v0
  • Replit Agent
  • Anse
  • TypingMind
  • BetterChatGPT
  • LibreChat
  • Warp AI
  • Pieces
  • Fig AI
Embed badge
vskill VERIFIED badge
[![vskill VERIFIED](https://verified-skill.com/api/v1/skills/haomingz/kimi-skills/api-doc-gen/badge)](https://verified-skill.com/skills/haomingz/kimi-skills/api-doc-gen)

Something wrong with this skill or its page? Tell us.