Skip to content

Routes

openapi_first.templates.crud_app.routes

CRUD route handlers bound via OpenAPI operationId.

These handlers explicitly control HTTP status codes to ensure runtime behavior matches the OpenAPI contract.

This module defines OpenAPI-bound operation handlers for a simple CRUD service. Functions in this module are bound to HTTP routes exclusively via OpenAPI operationId values.

Handlers explicitly control HTTP response status codes to ensure runtime behavior matches the OpenAPI contract. Error conditions are translated into explicit HTTP responses rather than relying on implicit framework behavior.

No routing decorators or path definitions appear in this module. All routing, HTTP methods, and schemas are defined in the OpenAPI specification.

Functions

create_item

create_item(payload: dict, response: Response)

Create a new item.

Implements the OpenAPI operation identified by operationId: create_item.

Parameters

payload : dict Item attributes excluding the id field. response : fastapi.Response Response object used to set the HTTP status code.

Returns

dict The newly created item.

delete_item

delete_item(item_id: int, response: Response)

Delete an existing item.

Implements the OpenAPI operation identified by operationId: delete_item.

Parameters

item_id : int Identifier of the item to delete. response : fastapi.Response Response object used to set the HTTP status code.

Returns

None No content.

Raises

HTTPException 404 if the item does not exist.

get_item

get_item(item_id: int)

Retrieve a single item by ID.

Implements the OpenAPI operation identified by operationId: get_item.

Parameters

item_id : int Identifier of the item to retrieve.

Returns

dict The requested item.

Raises

HTTPException 404 if the item does not exist.

list_items

list_items()

List all items.

Implements the OpenAPI operation identified by operationId: list_items.

Returns

list[dict] A list of item representations.

update_item

update_item(item_id: int, payload: dict)

Update an existing item.

Implements the OpenAPI operation identified by operationId: update_item.

Parameters

item_id : int Identifier of the item to update. payload : dict Item attributes excluding the id field.

Returns

dict The updated item.

Raises

HTTPException 404 if the item does not exist.