skills sourced live from GitHub · all skills listed are free · each skill is provided under its author's license.
home / Document Processing / Api Documentation Generator Skill by @sickn33
The skill is the plugins/agentic-awesome-skills-claude/skills/api-documentation-generator folder inside that repository. Copy it into the folder your agent loads skills from; check your agent's documentation for where that is.
Generate comprehensive, developer-friendly API documentation from code, including endpoints, parameters, examples, and best practices.
Reads an API's code and produces documentation: endpoints, parameters, examples and usage guidance. It works step by step, analysing the structure first, then documenting endpoints, then adding guidelines.
The original SKILL.md is organised into these sections:
Written and maintained by @sickn33. It is published under the MIT license, which allows reuse with attribution. See the author profile. SkillDirectory does not claim authorship: this page adds our own review and links back to the original, and the skill's text belongs to its author.
# API Documentation Generator ## Overview Automatically generate clear, comprehensive API documentation from your codebase. This skill helps you create professional documentation that includes endpoint descriptions, request/response examples, authentication details, error handling, and usage guidelines. Perfect for REST APIs, GraphQL APIs, and WebSocket APIs. ## When to Use This Skill - Use when you need to document a new API - Use when updating existing API documentation - Use when your API lacks clear documentation - Use when onboarding new developers to your API - Use when preparing API documentation for external users - Use when creating OpenAPI/Swagger specifications ## How It Works ### Step 1: Analyze the API Structure First, I'll examine your API codebase to understand: - Available endpoints and routes - HTTP methods (GET, POST, PUT, DELETE, etc.) - Request parameters and body structure - Response formats and status codes - Authentication and authorization requirements …
Excerpt only, quoted from the author's repository. Open the repository for the complete file.