api-doc-gen

Generate and validate Markdown API documentation from Go source code.

Updated Feb 1, 2026

Search Tags:#developer tools #code generation #go #rest api #api documentation #documentation validation

Ready to run

npx skills add https://github.com/witooh/skills --skill api-doc-gen

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-doc-gen
Source: https://github.com/witooh/skills/tree/main/skills/api-doc-gen
Command: npx skills add https://github.com/witooh/skills --skill api-doc-gen

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation and validation of API documentation, ensuring it accurately reflects the codebase and maintains consistency across services.

Core Features & Use Cases

Generate API Docs: Scans Go source code (Fiber, Echo, Chi, Gin) to produce standardized Markdown API documentation.
Update API Docs: Diffs existing documentation against code changes and updates only modified sections, preserving manual notes.
Validate API Docs: Compares documentation against the codebase to identify and report discrepancies without altering files.
Use Case: After updating API endpoints, use this skill to automatically regenerate or validate the docs/api-doc.md file to ensure it's up-to-date with the latest code.

Quick Start

Generate the API documentation for the current project.

Frequently Asked Questions about api-doc-gen

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

FAQPage Schema

How do I generate API documentation from Go source code automatically?▼

You can generate API documentation from Go source code by scanning route definitions, handler functions, and request/response structs to produce standardized Markdown documentation for frameworks like Fiber, Echo, Chi, and Gin.

Can I validate existing API docs against my Go codebase without overwriting files?▼

Yes, validating API docs against your Go codebase compares the documentation with the codebase to identify and report discrepancies without altering any files.

Does API documentation generation work with the Fiber and Echo web frameworks?▼

API documentation generation works with multiple Go web frameworks including Fiber, Echo, Chi, and Gin, scanning their specific route definitions to create Markdown docs.

How can I update Markdown API docs while preserving manual notes?▼

Updating Markdown API docs while preserving manual notes diffs existing documentation against code changes and modifies only the affected sections, leaving manual additions intact.

What is the best way to maintain API documentation accuracy across multiple Go services?▼

Maintaining API documentation accuracy across multiple Go services is achieved by automating validation and generation from source code, ensuring Markdown docs consistently reflect route definitions and handler changes.