Generate API specification documentation from codebase analysis. Detects REST endpoints, function signatures, type definitions, and schemas. Triggers: API specification, endpoints, REST API, type definitions, OpenAPI, Swagger, API documentation.
/plugin marketplace add thkt/claude-config/plugin install complete-workflow-system@thkt-development-workflowsThis skill is limited to using the following tools:
EVALUATIONS.mdscripts/detect-endpoints.shscripts/extract-types.shAuto-generate API documentation from codebase analysis.
| Category | Targets |
|---|---|
| REST Endpoints | Express, Fastify, Hono, Next.js, Flask, FastAPI, Django REST |
| Functions | tree-sitter extraction, TypeScript types, JSDoc, docstrings |
| Types | interface, type, Zod, Yup, dataclass, Pydantic |
| OpenAPI | openapi.yaml/json, swagger.yaml/json |
| Framework | Pattern |
|---|---|
| Express/Fastify/Hono | app.get(), router.post() |
| Next.js | app/api/**/route.ts, pages/api/**/*.ts |
| Flask | @app.route() |
| FastAPI | @app.get(), @app.post() |
| Django REST | @api_view |
| Script | Purpose |
|---|---|
scripts/detect-endpoints.sh | HTTP method, path, handler, file location |
scripts/extract-types.sh | Type name, fields, related types |
# API Specification
## Endpoint List
### GET /api/users
**Request**: params table
**Response**: JSON example
## Type Definitions
### User
| Field | Type | Description |
/docs:api # Generate API docs
"Generate API specification" # Natural language
After generation, validate output with:
~/.claude/skills/scripts/validate-markdown.sh {output-file}
Non-blocking (warnings only) - style issues don't block document creation.
documenting-architecture, setting-up-docs, documenting-domainsThis skill should be used when the user asks to "create a slash command", "add a command", "write a custom command", "define command arguments", "use command frontmatter", "organize commands", "create command with file references", "interactive command", "use AskUserQuestion in command", or needs guidance on slash command structure, YAML frontmatter fields, dynamic arguments, bash execution in commands, user interaction patterns, or command development best practices for Claude Code.
This skill should be used when the user asks to "create an agent", "add an agent", "write a subagent", "agent frontmatter", "when to use description", "agent examples", "agent tools", "agent colors", "autonomous agent", or needs guidance on agent structure, system prompts, triggering conditions, or agent development best practices for Claude Code plugins.
This skill should be used when the user asks to "create a hook", "add a PreToolUse/PostToolUse/Stop hook", "validate tool use", "implement prompt-based hooks", "use ${CLAUDE_PLUGIN_ROOT}", "set up event-driven automation", "block dangerous commands", or mentions hook events (PreToolUse, PostToolUse, Stop, SubagentStop, SessionStart, SessionEnd, UserPromptSubmit, PreCompact, Notification). Provides comprehensive guidance for creating and implementing Claude Code plugin hooks with focus on advanced prompt-based hooks API.