Skip to content

REST API

create_item()

Create a new item from the request body.

Returns:

Type Description
Response

201 with the created item, 422 on validation error, or 500 on error.

Source code in templates/api/handler.py
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
@app.post("/items")
def create_item() -> Response:
    """Create a new item from the request body.

    Returns:
        201 with the created item, 422 on validation error, or 500 on error.
    """
    body = app.current_event.json_body

    try:
        item = Item.model_validate(body)
    except ValidationError as exc:
        return Response(status_code=422, content_type="application/json", body=dumps({"errors": loads(exc.json())}))

    try:
        repository.put_item(item.model_dump())
    except Exception as exc:
        logger.error("DynamoDB put_item failed", exc_info=exc)
        return Response(
            status_code=500, content_type="application/json", body=dumps({"message": "Internal server error"})
        )

    return Response(status_code=201, content_type="application/json", body=dumps(item.dump()))

get_item(id)

Retrieve an item by ID.

Parameters:

Name Type Description Default
id str

The unique identifier of the item.

required

Returns:

Type Description
Response

200 with the item, 404 if not found, or 500 on error.

Source code in templates/api/handler.py
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
@app.get("/items/<id>")
def get_item(id: str) -> Response:
    """Retrieve an item by ID.

    Args:
        id: The unique identifier of the item.

    Returns:
        200 with the item, 404 if not found, or 500 on error.
    """
    try:
        item = repository.get_item(id)
    except Exception as exc:
        logger.error("DynamoDB get_item failed", exc_info=exc)
        return Response(
            status_code=500, content_type="application/json", body=dumps({"message": "Internal server error"})
        )

    if item is None:
        return Response(status_code=404, content_type="application/json", body=dumps({"message": "Not found"}))

    return Response(status_code=200, content_type="application/json", body=dumps(item))

main(event, context)

Lambda entry point for the API Gateway handler.

Parameters:

Name Type Description Default
event dict

The API Gateway proxy event.

required
context LambdaContext

The Lambda execution context.

required

Returns:

Type Description
dict

The API Gateway proxy response.

Source code in templates/api/handler.py
72
73
74
75
76
77
78
79
80
81
82
83
84
85
@logger.inject_lambda_context
@tracer.capture_lambda_handler
@metrics.log_metrics
def main(event: dict, context: LambdaContext) -> dict:
    """Lambda entry point for the API Gateway handler.

    Args:
        event: The API Gateway proxy event.
        context: The Lambda execution context.

    Returns:
        The API Gateway proxy response.
    """
    return app.resolve(event, context)