documenting-apis
从代码库分析生成API规范文档。检测REST端点、函数签名、类型定义和模式。触发词:API specification, endpoints, REST API, type definitions, OpenAPI, Swagger, API documentation
📖 中文导读:从代码库分析生成API规范文档。检测REST端点、函数签名、类型定义和模式。触发词:API specification, endpoints, REST API, type definitions, OpenAPI, Swagger, API documentation 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。
name: documenting-apis description: > Generate API specification from codebase - endpoints, types, schemas. Use when generating API documentation, documenting endpoints, or when user mentions API docs, API仕様, OpenAPI, Swagger, REST API, endpoint documentation. allowed-tools: [Read, Write, Grep, Glob, Bash, Task] context: fork user-invocable: false
API Specification Generation
Detection
| Category | Pattern |
|---|---|
| Endpoints | Express, Fastify, Next.js, Flask, etc. |
| Functions | tree-sitter, TypeScript, JSDoc |
| Types | interface, type, Zod, Pydantic |
| OpenAPI | openapi.yaml, swagger.yaml |
| Authentication | Auth middleware, JWT, OAuth patterns |
Framework Patterns
| Framework | Pattern |
|---|---|
| Express | app.get(), router.post() |
| Next.js | app/api/**/route.ts |
| Flask | @app.route() |
| FastAPI | @app.get(), @app.post() |