api-documentation

API Documentation Prompt

Purpose

Generate comprehensive API documentation for FastAPI endpoints.

Input Required

• Endpoint code or router file
• Context about the API purpose

If the output will be saved as a standalone Markdown file, apply .github/instructions/document-frontmatter.instructions.md and prepend the required document metadata frontmatter before the first heading. If updating an existing doc, preserve the original fields and add or update Last Author, Last Updated, and Last Model Used using full ISO 8601 UTC timestamps.

Template

Generate API documentation for the following FastAPI endpoints:

**API Context**: {api_description}

**Base URL**: {base_url}

**Code**:
```python
{router_code}

Generate documentation including:

1. API Overview
2. Authentication requirements
3. Each endpoint with:
   • Method and path
   • Description
   • Request parameters/body
   • Response format
   • Example request/response
   • Error responses
4. Common error codes
5. Rate limiting (if applicable)

Format as Markdown suitable for a docs site or README.

## Example

### Input

Generate API documentation for the following FastAPI endpoints:

API Context: API for <APP_TITLE>

Base URL: http://localhost:8000/api/v1

Code:

from fastapi import APIRouter, HTTPException, Query
from pydantic import BaseModel
from uuid import UUID

router = APIRouter(prefix="/complaints", tags=["complaints"])

class ComplaintCreate(BaseModel):
    customer_id: str
    complaint_type: str
    description: str
    priority: int = 3

class ComplaintResponse(BaseModel):
    id: UUID
    customer_id: str
    complaint_type: str
    description: str
    priority: int
    status: str

@router.get("/")
async def list_complaints(
    status: str | None = Query(None),
    page: int = Query(1, ge=1),
    per_page: int = Query(25, ge=1, le=100)
) -> dict:
    """List all complaints with optional filtering."""
    ...

@router.get("/{complaint_id}")
async def get_complaint(complaint_id: UUID) -> ComplaintResponse:
    """Get a specific complaint by ID."""
    ...