Can I use JSDoc to provide extra context?

Yes, the skill specifically looks for JSDoc in handlers.ts to extract summaries, descriptions, parameter info, and potential HTTP status codes.

How does it handle database types?

It analyzes Drizzle ORM schema.ts files to automatically map database table definitions to OpenAPI component schemas, including support for types like serial, uuid, and jsonb.

Does it overwrite my existing openapi.yaml file?

No, the skill is designed to perform an update. It reads your existing apps/server/docs/openapi.yaml and merges new module paths and schemas into it.

Which validation libraries are supported?

It is optimized for Zod, extracting field types, constraints, and requirements directly from your validators.ts files.

API Documenter

Name: API Documenter
Author: gaegulgaegul

bygaegulgaegul

0•

API Development

Automatically generates and updates OpenAPI 3.0 documentation by analyzing TypeScript handlers, Zod validators, and database schemas.

API Documenter is a specialized skill for Claude Code designed to automate the maintenance of RESTful API specifications. It intelligently parses your project's source code—including JSDoc comments in handlers, route definitions, Zod validation schemas, and Drizzle ORM models—to ensure your openapi.yaml stays synchronized with the actual implementation. By leveraging MCP tools for industry best practices and referencing past documentation patterns, it eliminates the manual drudgery of updating Swagger UI while maintaining high-quality, standardized API contracts.

Key Features

010 GitHub stars

02Deep analysis of Zod schemas for accurate request/response mapping

03Integration with context7 and memory MCPs for best-practice compliance

04Automated OpenAPI 3.0 specification generation and merging

05Metadata extraction from JSDoc comments and Router definitions

06Direct mapping of Drizzle ORM schemas to OpenAPI components

Use Cases

01Standardizing API documentation across teams using Zod and TypeScript

02Generating comprehensive API specifications for new feature modules

03Syncing Swagger UI documentation with rapid backend code changes

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add gaegulgaegul/gaegulzip api-documenter

For use in Claude.ai and ChatGPT

Download Skill