AI API Documentation Generator

AI Prompts to Build This

Copy these build prompts into Claude, Cursor, or your AI coding tool. Create a free account to unlock the full research behind them.

1. 1. Project Setup

   Create a Next.js app for an API Documentation Generator.
   
   Features:
   - GitHub OAuth to connect repositories
   - Dashboard showing connected repos and their docs status
   - Settings to configure which folders contain API code
   - Preview mode to see generated docs before publishing
   - Custom domain support for hosted docs
   
   Use Supabase for auth and database. Store: user, repos, generated_docs, custom_domains.

2. 2. Core Feature

   Create the documentation generator:
   
   1. Fetch API route files from GitHub (look for /api/, /routes/, common patterns)
   2. For each file, send to Claude with prompt: "Analyze this API code and extract: HTTP method, endpoint path, query parameters, request body schema, response schema, description"
   3. Generate OpenAPI spec from extracted data
   4. Convert OpenAPI to interactive documentation using Redoc or custom renderer
   5. Create example requests with realistic mock data
   6. Generate code snippets for curl, JavaScript, Python
   
   Run this on GitHub webhook for push events to keep docs updated.

3. 3. Docs Site

   Create the hosted documentation site:
   
   - Clean, modern design similar to Stripe or Vercel docs
   - Left sidebar with endpoint navigation grouped by resource
   - Main content area with: endpoint description, parameters table, request/response examples
   - Right sidebar with code snippets (toggleable languages)
   - Built-in search across all endpoints
   - Dark/light mode toggle
   - "Try it" button to make live requests (if user adds API key)
   
   Deploy each user's docs to a subdomain: {project}.docs.yourdomain.com