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

@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.
    """
    try:
        item = Item.model_validate_json(app.current_event.body)
    except ValidationError as exc:
        return Response(status_code=422, content_type="application/json", body=dumps({"errors": exc.errors()}))

    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=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

@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:
        if (item := repository.get_item(id)) is None:
            return Response(status_code=404, content_type="application/json", body=dumps({"message": "Not found"}))
        item = Item.model_validate(item)  # Validate model after retrieval to ensure data integrity
    except Exception as exc:
        message = (
            "Item validation failed" if isinstance(exc, ValidationError) else f"Error retrieving item with id {id}"
        )
        logger.error(message, exc_info=exc)
        return Response(
            status_code=500, content_type="application/json", body=dumps({"message": "Internal server error"})
        )
    return Response(status_code=200, content_type="application/json", body=item.dump())

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

@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)