documentation-create-api

API Documentation Creation and Generation

This prompt generates comprehensive API documentation including endpoint specifications, authentication flows, integration examples, and developer guides with proper OpenAPI standards.

🎯 API DOCUMENTATION OBJECTIVES:

1. ANALYZE existing API structure and extract complete endpoint specifications
2. GENERATE OpenAPI 3.0 specification with comprehensive schemas and examples
3. CREATE integration guides with practical code examples in multiple languages
4. DOCUMENT authentication flows with security considerations and examples
5. ESTABLISH maintenance processes for keeping documentation current with code changes

🔍 API DISCOVERY AND ANALYSIS:

STEP 1: API Endpoint Discovery

Automated Endpoint Detection:

# Discover API endpoints across the codebase
echo "🔍 Discovering API endpoints..."

# Next.js API routes discovery
if [ -d "src/app/api" ] || [ -d "app/api" ] || [ -d "pages/api" ]; then
    echo "## Next.js API Routes:"
    find . -path "*/api/*" -name "*.ts" -o -name "*.js" | grep -E "(route|api)" | sort
fi

# Express.js routes discovery
echo -e "\n## Express/Node.js Routes:"
grep -r "app\.\(get\|post\|put\|delete\|patch\)" --include="*.ts" --include="*.js" src/ 2>/dev/null | head -20

# FastAPI/Python routes (if applicable)
echo -e "\n## Python API Routes:"
grep -r "@app\.\(get\|post\|put\|delete\|patch\)" --include="*.py" . 2>/dev/null | head -10

# GraphQL schema discovery
echo -e "\n## GraphQL Schema:"
find . -name "*.graphql" -o -name "schema.ts" -o -name "typeDefs.ts" | head -10

# API middleware and authentication
echo -e "\n## Authentication Middleware:"
grep -r "auth\|jwt\|token" --include="*.ts" --include="*.js" src/ | grep -E "(middleware|auth)" | head -10

API Structure Analysis:

# Analyze API structure and patterns
echo "📊 Analyzing API structure..."

# Check for OpenAPI/Swagger existing docs
echo "## Existing API Documentation:"
find . -name "swagger*" -o -name "openapi*" -o -name "api-docs*" | head -10

# Analyze request/response patterns
echo -e "\n## Request/Response Patterns:"
grep -r "Request\|Response" --include="*.ts" src/ | grep -E "(interface|type)" | head -10

# Database models (for API data structures)
echo -e "\n## Data Models:"
find . -name "*.model.ts" -o -name "*.schema.ts" -o -name "prisma.schema" | head -10

# API versioning strategy
echo -e "\n## API Versioning:"
grep -r "v1\|v2\|version" --include="*.ts" --include="*.js" src/ | grep -i api | head -5