endpoint

Command /fastapi:endpoint

Create a new endpoint with service and test.

Instructions

Step 1: Analyze existing module

Read module files:

• src/modules/{{ module }}/routers.py
• src/modules/{{ module }}/services.py
• src/modules/{{ module }}/dto.py

Step 2: Determine what needs to be created

Based on {{ method }} {{ path }} determine:

• Are new DTOs needed
• Is a new service method needed
• Is a new repository method needed

Step 3: Create components

Endpoint in routers.py

@router.{{ method | lower }}("{{ path }}")
@inject
async def {{ endpoint_name }}(
    # Path parameters from {{ path }}
    id: int,
    # Body for POST/PATCH/PUT
    data: {{ DTO }}DTO,
    # DI
    service: Annotated[
        {{ module | capitalize }}Service,
        Depends(Provide[Container.{{ module }}_service]),
    ],
) -> {{ ResponseDTO }}:
    """{{ description }}."""
    return await service.{{ method_name }}(id, data)

Method in services.py

async def {{ method_name }}(self, ...) -> {{ ReturnType }}:
    """{{ description }}."""
    # Business logic
    pass

Test in test_routers.py

class Test{{ endpoint_name | capitalize }}:
    """Tests for {{ method }} {{ path }}."""

    async def test_{{ endpoint_name }}_success(
        self,
        client: AsyncClient,
    ) -> None:
        """Successfully {{ description | lower }}."""
        response = await client.{{ method | lower }}(
            "{{ path }}",
            json={...} if "{{ method }}" in ["POST", "PATCH", "PUT"] else None,
        )

        assert response.status_code == {{ expected_status }}

    async def test_{{ endpoint_name }}_not_found(
        self,
        client: AsyncClient,
    ) -> None:
        """{{ endpoint_name }} returns 404 when resource not found."""
        response = await client.{{ method | lower }}("{{ path_with_invalid_id }}")

        assert response.status_code == 404

Examples

GET /users/{user_id}/orders