API Docs Generator

API Docs Generator

Generate beautiful static HTML documentation from OpenAPI specs. Single-file output with dark theme, search, and responsive design. Zero dependencies.

Part of the API Launchpad toolkit by [CodeVault](https://codevault.dev).

Features

• Single-file HTML output — host anywhere (S3, GitHub Pages, Netlify, Vercel)
• Dark theme with syntax-highlighted code blocks and amber accents
• Sidebar navigation with tag-based endpoint grouping
• Live search across endpoint names, paths, and descriptions
• Request/response examples auto-generated from schema definitions
• Parameter tables with type, location, required status, and description
• Responsive design — works on desktop and mobile
• Zero dependencies — runs on Python stdlib only

Quick Start

# Generate docs from an OpenAPI spec
python3 src/main.py --spec openapi.json --output docs.html

# Generate demo docs
python3 src/main.py --demo --output docs.html

# Print HTML to stdout
python3 src/main.py --demo

Then open docs.html in your browser.

Using as a Library

from main import generate_docs
import json

# Load your OpenAPI spec
with open("openapi.json") as f:
    spec = json.load(f)

# Generate HTML documentation
html = generate_docs(spec, custom_css="""
    /* Override brand color */
    .logo { color: #00FF88; }
""")

# Save to file
with open("docs.html", "w") as f:
    f.write(html)

What Gets Generated

The output HTML includes:

1. Header with API title, version, and description

2. Server list with base URLs

3. Sidebar navigation grouped by OpenAPI tags

... continues with setup instructions, usage examples, and more.