api-docs

Analyze route definitions to generate OpenAPI YAML or Markdown API docs.

11|Updated Apr 16, 2026

Search Tags:#documentation #routing #openapi #code-analysis #express #api-docs

Ready to run

npx skills add https://github.com/berkcangumusisik/claude-code-practices --skill api-docs-berkcangumusisik

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-docs
Source: https://github.com/berkcangumusisik/claude-code-practices/tree/main/skills/api-docs
Command: npx skills add https://github.com/berkcangumusisik/claude-code-practices --skill api-docs-berkcangumusisik

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates the creation of API documentation by analyzing route definitions across common frameworks and extracting methods, paths, parameters, and payload shapes.

Core Features & Use Cases

Extracts HTTP methods, paths, path/query/body parameters, and response shapes from Express, Fastify, Hono, and similar routers.
Generates OpenAPI 3.0 YAML or human-friendly Markdown tables to keep docs in sync with code.
Use Case: Imagine a microservices project where you need consistent, auto-generated docs for every route and versioned API surface.

Quick Start

Point the skill at your routes directory and run it to produce OpenAPI YAML or Markdown docs.

Frequently Asked Questions about api-docs

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

FAQPage Schema

How do I generate API documentation from Express route definitions?▼

Generating API documentation from Express route definitions involves analyzing your router code to extract HTTP methods, paths, parameters, and response shapes. The skill automatically parses these route definitions to produce OpenAPI 3.0 YAML or Markdown tables, keeping your docs in sync with your codebase.

Can I extract OpenAPI YAML from Fastify or Hono routing layers?▼

Yes, you can extract OpenAPI YAML from Fastify or Hono routing layers. The skill analyzes route definitions across these supported frameworks, extracting methods, paths, request and response schemas, and auth details to output valid OpenAPI 3.0 YAML.

What is the best way to automate API docs creation for a microservices project?▼

Automating API docs creation for a microservices project is done by pointing the skill at your routes directory. It analyzes the code to extract payload shapes and paths, generating consistent, auto-generated Markdown or OpenAPI documentation for every route and versioned API surface.

Does auto-generated API documentation include request and response schemas?▼

Yes, auto-generated API documentation includes request and response schemas. The analysis extracts HTTP methods, paths, path/query/body parameters, and response shapes from your routing layers, capturing all payload structures and auth details in the final OpenAPI YAML or Markdown output.

How do I convert code analysis into Markdown tables for API documentation?▼

Converting code analysis into Markdown tables for API documentation requires parsing your route definitions to identify methods and parameters. The skill performs this code analysis and outputs human-friendly Markdown tables that map your extracted routes, schemas, and parameters directly.