Api Reference Documentation

This handles the full OpenAPI specification workflow for documenting REST and GraphQL APIs. You get templates for endpoint definitions, authentication flows, rate limiting, pagination, and error responses. It pushes you toward OpenAPI 3.0+ format with concrete examples in multiple languages, which is good because half-documented APIs are worse than no documentation. The reference guides include actual YAML specs you can adapt rather than starting from scratch. Most useful when you're formalizing an existing API or need to generate Swagger UI docs that won't embarrass you in front of frontend developers.

skills.sh installs: 499
GitHub stars: 379
last updated: Aug 21, 2026

View on GitHub

Install

$ npx -y skills add aj-geddes/useful-ai-prompts --skill api-reference-documentation --agent claude-code

Installs into .claude/skills of the current project.

Files

Overview

Generate professional API documentation that developers can use to integrate with your API, including endpoint specifications, authentication, request/response examples, and interactive documentation.

When to Use

Documenting REST APIs
Creating OpenAPI/Swagger specifications
GraphQL API documentation
SDK and client library docs
API authentication guides
Rate limiting documentation
Webhook documentation
API versioning guides

Quick Start

Minimal working example:

openapi: 3.0.3
info:
  title: E-Commerce API
  description: |
    Complete API for managing e-commerce operations including products,
    orders, customers, and payments.

    ## Authentication
    All endpoints require Bearer token authentication. Include your API key
    in the Authorization header: `Authorization: Bearer YOUR_API_KEY`

    ## Rate Limiting
    - 1000 requests per hour for authenticated users
    - 100 requests per hour for unauthenticated requests

SKILL.md on GitHub