skills.rest
foutoucour
foutoucourCOMMUNITY
Explore all skills by this author →
𝕏@jordiriera_cgGitHub

api-documenter

Scan code for API route handlers and generate OpenAPI 3.0 specs and Markdown docs.

Updated Mar 24, 2026
Search Tags:#documentation#markdown#openapi#generate#controllers#routes#api-docs
One-click install
npx skills add https://github.com/foutoucour/guitar-match --skill api-documenter-foutoucour
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-documenter
Source: https://github.com/foutoucour/guitar-match/tree/main/.claude/skills/api-documenter
Command: npx skills add https://github.com/foutoucour/guitar-match --skill api-documenter-foutoucour

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate up-to-date API documentation from code endpoints whenever APIs are added or changed, reducing manual documentation effort.

Core Features & Use Cases

  • Detects routes and controller mappings across frameworks (Express, FastAPI, Django, Spring, Go net/http, etc.).
  • Generates OpenAPI specs and Markdown docs and merges them with existing documentation without overwriting hand-written notes.
  • Supports incremental updates, preserving manual notes and providing a changelog of updates.

Quick Start

Scan the codebase for API routes and controllers, and generate or update OpenAPI and Markdown documentation.

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 specifications from existing route handlers and controllers?▼

Generate OpenAPI 3.0 specifications by scanning your codebase for route handlers and controllers across frameworks like Express, FastAPI, Django, Spring, and Go net/http. The tool produces or updates OpenAPI specs and Markdown docs, merging them with existing documentation.

Can I update API documentation incrementally without overwriting manual notes?▼

Yes, API documentation supports incremental updates that merge with existing docs while preserving manual notes. It scans for endpoints, updates the OpenAPI specs and Markdown files, and provides a changelog of updates so hand-written content remains intact.

What is the best way to document API endpoints across multiple frameworks?▼

The best way to document API endpoints across multiple frameworks is to scan the codebase for route handlers and controllers automatically. This approach detects mappings in Express, FastAPI, Django, Spring, and Go net/http, then generates or updates OpenAPI and Markdown documentation.

Does generating Markdown docs from code merge with existing documentation?▼

Generating Markdown docs from code merges with existing documentation without overwriting hand-written notes. It scans your project for API routes and controllers, produces the Markdown files, and applies incremental updates to keep your API docs current.

Why does my API documentation fall out of sync when I add new endpoints?▼

API documentation falls out of sync because manually updating docs for new routes is error-prone. Scanning code for route handlers and controllers automatically generates or updates OpenAPI specs and Markdown docs, reducing manual effort whenever APIs change.

Related Skills

Explore More Software Engineering Skills→
NotysotyNotysoty
9

API Documentation Generator

Generate OpenAPI 3.0 YAML documentation from REST API route handlers.

Community
Advanced
Lautaro073Lautaro073

api-reference-documentation

Generates endpoints, models, and authentication details from OpenAPI 3.0 documents into Markdown-ready content.

Community
Intermediate
Vivekmano27Vivekmano27

api-docs-generator

Generate OpenAPI 3.0 documentation from NestJS and Django REST Framework codebases.

Community
Advanced
zinohomezinohome
1

openapi-generator

Generate OpenAPI 3.0/3.1 specs from JavaScript framework routes.

Community
Advanced