api-documentation-generator

Installation
Summary

Automatically generate clear, comprehensive API documentation from your codebase with endpoints, examples, and best practices.

  • Analyzes API structure to extract endpoints, HTTP methods, parameters, responses, authentication, and error patterns
  • Generates endpoint documentation with request/response specifications, code examples in multiple languages (cURL, JavaScript, Python), and error handling details
  • Supports REST APIs, GraphQL APIs, and WebSocket APIs with format-specific documentation patterns
  • Produces OpenAPI/Swagger specifications and Postman collections for interactive testing and integration
  • Includes usage guidelines covering authentication setup, rate limiting, pagination, filtering, and common error scenarios
SKILL.md

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

Related skills

More from davila7/claude-code-templates

Installs
433
GitHub Stars
27.2K
First Seen
Jan 25, 2026