开发
返回Skills 列表
API 文档生成 Skill
扫描代码里的路由（Flask/FastAPI/Express 简易支持），生成 Markdown 接口表初稿。
📁 API 文档生成 Skill /
SKILL.md0.6 KB
scripts
scan_routes.py0.9 KB
templates
doc_template.md0.2 KB
所有文件均为纯文本展示，仅提供查看与打包下载，不在服务器上执行。
SKILL.md
---
name: api-doc-generator
description: 扫描代码里的路由（Flask/FastAPI/Express 简易支持），生成 Markdown 接口表初稿。
---
# API 文档生成 Skill
## 触发条件
当用户的项目缺接口文档，想从现有代码快速生成一份底稿时触发。
## 执行步骤
1. 运行 scripts/scan_routes.py ./src > api.md 得到路由表。
2. AI 逐个接口补齐：用途、入参、出参、错误码（结合代码上下文）。
3. 按 templates/doc_template.md 排版输出正式文档。
## 依赖
纯 Python 标准库；支持 Flask/FastAPI 装饰器与 Express 风格调用的粗略扫描。
纯文本预览
全站累计复制 0 次
使用说明
解压后放入 Agent 技能目录；无需依赖，给 Agent 项目目录即可生成文档初稿再精修。
每个 IP 仅可点赞一次 · 点赞后不可取消
暂无评论，来发表第一条评论吧！