api-doc-gen
CommunityGenerate and validate API documentation from code.
Software Engineering#developer tools#code generation#go#rest api#api documentation#documentation validation
Authorwitooh
Version1.0.0
Installs0
System Documentation
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.mdfile to ensure it's up-to-date with the latest code.
Quick Start
Generate the API documentation for the current project.
Dependency Matrix
Required Modules
None requiredComponents
references
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: api-doc-gen Download link: https://github.com/witooh/skills/archive/main.zip#api-doc-gen Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.