Scaffold Router

IMPORTANT: When this command is invoked, you MUST actually CREATE the files. Do NOT just show the templates.

Step 1: Get Resource Details

If not provided, ask the user:

1. Resource name (e.g., "product", "order")
2. Whether it needs authentication (default: yes)
3. CRUD operations needed (default: all)

Step 2: CREATE the Router File

Use the Write tool to create this file at: {backend}/api/v1/router_{resource}.py

Replace all {Resource} with PascalCase, {resource} with snake_case, and {resources} with plural.

1. Router File: src/backend/api/v1/router_{resource}.py

"""
Router for {Resource} management.
"""

from fastapi import APIRouter, Depends, status
from sqlalchemy.ext.asyncio import AsyncSession
from typing import List, Optional

from api.deps import get_session, require_admin
from api.services.{resource}_service import {Resource}Service
from api.schemas.{resource} import (
    {Resource}Create,
    {Resource}Update,
    {Resource}Response,
)

router = APIRouter(prefix="/{resources}", tags=["{resources}"])


@router.post("", response_model={Resource}Response, status_code=status.HTTP_201_CREATED)
async def create_{resource}(
    data: {Resource}Create,
    session: AsyncSession = Depends(get_session),
    _: dict = Depends(require_admin),
):
    """Create a new {resource}."""
    service = {Resource}Service()
    return await service.create(session, data)


@router.get("/{{{resource}_id}}", response_model={Resource}Response)
async def get_{resource}(
    {resource}_id: str,
    session: AsyncSession = Depends(get_session),
):
    """Get {resource} by ID."""
    service = {Resource}Service()
    return await service.get_by_id(session, {resource}_id)


@router.get("", response_model=List[{Resource}Response])
async def list_{resources}(
    page: int = 1,
    per_page: int = 25,
    is_active: Optional[bool] = None,
    session: AsyncSession = Depends(get_session),
):
    """List {resources} with pagination."""
    service = {Resource}Service()
    items, _ = await service.list(session, page=page, per_page=per_page, is_active=is_active)
    return items


@router.put("/{{{resource}_id}}", response_model={Resource}Response)
async def update_{resource}(
    {resource}_id: str,
    data: {Resource}Update,
    session: AsyncSession = Depends(get_session),
    _: dict = Depends(require_admin),
):
    """Update {resource}."""
    service = {Resource}Service()
    return await service.update(session, {resource}_id, data)


@router.delete("/{{{resource}_id}}", status_code=status.HTTP_204_NO_CONTENT)
async def delete_{resource}(
    {resource}_id: str,
    session: AsyncSession = Depends(get_session),
    _: dict = Depends(require_admin),
):
    """Delete {resource}."""
    service = {Resource}Service()
    await service.delete(session, {resource}_id)

2. Also create corresponding:

• Schema file: src/backend/api/schemas/{resource}.py
• Service file: src/backend/api/services/{resource}_service.py
• Repository file: src/backend/api/repositories/{resource}_repository.py

3. Register router in app.py:

from api.v1.router_{resource} import router as {resource}_router
app.include_router({resource}_router, prefix="/api/v1")

Key Patterns to Follow

1. Use Depends(get_session) for database access
2. Use Depends(require_admin) or appropriate auth dependency
3. Return proper status codes (201 for create, 204 for delete)
4. Use response_model for automatic serialization
5. Instantiate service in endpoint, don't inject
6. Keep endpoints thin - delegate to service layer

Step 3: Register Router in app.py

After creating the router, ADD this import to {backend}/app.py:

from api.v1.router_{resource} import router as {resource}_router
app.include_router({resource}_router, prefix="/api/v1")

Step 4: Output Confirmation

After creating the file, output:

✅ Router created: {backend}/api/v1/router_{resource}.py

Don't forget to:
1. Register router in app.py (shown above)
2. Ensure service exists: {backend}/api/services/{resource}_service.py
3. Ensure schemas exist: {backend}/api/schemas/{resource}.py
4. Ensure repository exists: {backend}/api/repositories/{resource}_repository.py

CRITICAL REMINDER

This command MUST:

1. USE Write tool to CREATE the router file
2. Replace ALL placeholders with actual resource names
3. CREATE the file at the correct path
4. SHOW how to register in app.py
5. OUTPUT confirmation with checklist

DO NOT just show the template. ACTUALLY CREATE THE FILE.