api-documenter

Generate and update OpenAPI 3.0 specifications from TypeScript source files.

Updated Feb 2, 2026

Search Tags:#typescript #documentation #drizzle #openapi #zod #code-analysis #api-docs

Ready to run

npx skills add https://github.com/gaegulgaegul/gaegulzip --skill api-documenter-gaegulgaegul

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-documenter
Source: https://github.com/gaegulgaegul/gaegulzip/tree/main/.claude/skills/api-documenter
Command: npx skills add https://github.com/gaegulgaegul/gaegulzip --skill api-documenter-gaegulgaegul

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Automates the generation and maintenance of OpenAPI 3.0 specifications by analyzing handlers.ts, validators.ts, and schema.ts to produce up-to-date API docs.

Core Features & Use Cases

Handler and router analysis extracts endpoints, HTTP methods, and middleware from handlers.ts and index.ts.
Schema extraction derives request/response contracts from validators.ts and Drizzle schema.
OpenAPI integration merges generated paths into apps/server/docs/openapi.yaml, preserving existing documentation.
Best practices compliance adheres to OpenAPI 3.0 guidelines and references past patterns for consistency.

Quick Start

Run the API Documenter with a feature name to generate or update its OpenAPI specification.

Frequently Asked Questions about api-documenter

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I generate OpenAPI 3.0 specifications from TypeScript?▼

To generate OpenAPI 3.0 specifications from TypeScript, this tool analyzes your handlers.ts, validators.ts, and schema.ts files to extract endpoints, schemas, and contracts, then merges them into your openapi.yaml.

How does schema extraction work for Drizzle and Zod in API documentation?▼

Schema extraction for Drizzle and Zod in API documentation works by deriving request and response contracts directly from validators.ts and Drizzle schema definitions to produce accurate OpenAPI schemas.

Can I automatically update existing OpenAPI docs without losing previous content?▼

Yes, you can update existing OpenAPI docs without losing previous content, because the tool merges newly generated paths into apps/server/docs/openapi.yaml while preserving existing documentation.

Do I need a specific TypeScript runtime to analyze handlers and generate API docs?▼

Yes, you need a TypeScript runtime to analyze handlers and generate API docs, as the tool requires this environment to parse your feature modules and extract routing logic.

What is the best way to maintain API docs alongside Drizzle schema changes?▼

The best way to maintain API docs alongside Drizzle schema changes is to automate the process by analyzing updated schema.ts and validators.ts files to regenerate corresponding OpenAPI paths.