sickn33 avatar

Api Documentation Generator

If you've ever stared at a messy codebase wondering how to explain your API to other developers, this skill walks through your routes and generates proper documentation with request/response schemas, auth requirements, and working code examples in multiple languages. It covers REST, GraphQL, and WebSocket APIs, creating everything from endpoint specs to error handling guides to OpenAPI specs. The format is comprehensive but structured, with examples showing realistic JSON payloads, curl commands, and client code in JavaScript and Python. This is genuinely helpful if you're documenting a new API or fixing sparse docs, though you'll want to review the output since auto-generated docs always need some human polish to match your actual implementation quirks.

skills.sh installs
1.9K
GitHub stars
43.1K
last updated
Jul 14, 2026

Install

$ npx -y skills add sickn33/antigravity-awesome-skills --skill api-documentation-generator --agent claude-code

Installs into .claude/skills of the current project.

Files

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

Sponsors

Details

Repository
github.com/sickn33/antigravity-awesome-skills
Categories
Backend & APIs, Documentation, Automation & Workflows

More from sickn33/antigravity-awesome-skills

All 708
1affaan-m avatarmysql-patternsaffaan-m/everything-claude-codemysql patterns1.8Kskills.sh installs
2sickn33 avatardatabase-designsickn33/antigravity-awesome-skillsdatabase design1.7Kskills.sh installs
3affaan-m avatarprisma-patternsaffaan-m/everything-claude-codeprisma patterns1.4Kskills.sh installs
4lobehub avatardrizzlelobehub/lobe-chatdrizzle1.4Kskills.sh installs
5mindrally avatarnextjs-typescript-tailwindcss-supabasemindrally/skillsFull-stack Next.js 14 development with TypeScript, TailwindCSS, and Supabase for building production-ready web applications.1.4Kskills.sh installs
6aradotso avatartavily-key-generator-proxyaradotso/trending-skillstavily key generator proxy1.3Kskills.sh installs