Skip to content

CRUD Router API Reference

crud_router is a utility function for creating and configuring a FastAPI router with CRUD endpoints for a given model.

Function Definition

Creates and configures a FastAPI router with CRUD endpoints for a given model.

This utility function streamlines the process of setting up a router for CRUD operations, using a custom EndpointCreator if provided, and managing dependency injections as well as selective method inclusions or exclusions.

Parameters:

Name Type Description Default
session Callable

The SQLAlchemy async session.

 required
model type[DeclarativeBase]

The SQLAlchemy model.

 required
crud Optional[FastCRUD]

An optional FastCRUD instance. If not provided, uses FastCRUD(model).

 None
create_schema Type[CreateSchemaType]

Pydantic schema for creating an item.

 required
update_schema Type[UpdateSchemaType]

Pydantic schema for updating an item.

 required
delete_schema Optional[Type[DeleteSchemaType]]

Optional Pydantic schema for deleting an item.

 None
path str

Base path for the CRUD endpoints.

 ''
tags Optional[list[Union[str, Enum]]]

Optional list of tags for grouping endpoints in the documentation.

 None
include_in_schema bool

Whether to include the created endpoints in the OpenAPI schema.

 True
create_deps Sequence[Callable]

Optional list of functions to be injected as dependencies for the create endpoint.

 []
read_deps Sequence[Callable]

Optional list of functions to be injected as dependencies for the read endpoint.

 []
read_multi_deps Sequence[Callable]

Optional list of functions to be injected as dependencies for the read multiple items endpoint.

 []
update_deps Sequence[Callable]

Optional list of functions to be injected as dependencies for the update endpoint.

 []
delete_deps Sequence[Callable]

Optional list of functions to be injected as dependencies for the delete endpoint.

 []
db_delete_deps Sequence[Callable]

Optional list of functions to be injected as dependencies for the hard delete endpoint.

 []
included_methods Optional[list[str]]

Optional list of CRUD methods to include. If None, all methods are included.

 None
deleted_methods Optional[list[str]]

Optional list of CRUD methods to exclude.

 None
endpoint_creator Optional[Type[EndpointCreator]]

Optional custom class derived from EndpointCreator for advanced customization.

 None
is_deleted_column str

Optional column name to use for indicating a soft delete. Defaults to "is_deleted".

 'is_deleted'
deleted_at_column str

Optional column name to use for storing the timestamp of a soft delete. Defaults to "deleted_at".

 'deleted_at'
updated_at_column str

Optional column name to use for storing the timestamp of an update. Defaults to "updated_at".

 'updated_at'
endpoint_names Optional[dict[str, str]]

Optional dictionary to customize endpoint names for CRUD operations. Keys are operation types ("create", "read", "update", "delete", "db_delete", "read_multi", "read_paginated"), and values are the custom names to use. Unspecified operations will use default names.

 None
filter_config Optional[Union[FilterConfig, dict]]

Optional FilterConfig instance or dictionary to configure filters for the read_multi and read_paginated endpoints.

 None

Returns:

Type Description
APIRouter

Configured APIRouter instance with the CRUD endpoints.

Raises:

Type Description
ValueError

If both 'included_methods' and 'deleted_methods' are provided.

Examples:

Basic Setup: 

router = crud_router(
    session=async_session,
    model=MyModel,
    create_schema=CreateMyModelSchema,
    update_schema=UpdateMyModelSchema,
    path="/mymodel",
    tags=["MyModel"]
)

With Custom Dependencies: 

def get_current_user(token: str = Depends(oauth2_scheme)):
    # Implement user retrieval logic
    return ...

router = crud_router(
    session=async_session,
    model=UserModel,
    create_schema=CreateUserSchema,
    update_schema=UpdateUserSchema,
    read_deps=[get_current_user],
    update_deps=[get_current_user],
    path="/users",
    tags=["Users"]
)

Adding Delete Endpoints: 

router = crud_router(
    session=async_session,
    model=ProductModel,
    create_schema=CreateProductSchema,
    update_schema=UpdateProductSchema,
    delete_schema=DeleteProductSchema,
    path="/products",
    tags=["Products"]
)

Customizing Path and Tags: 

router = crud_router(
    session=async_session,
    model=OrderModel,
    crud=CRUDOrderModel(OrderModel),
    create_schema=CreateOrderSchema,
    update_schema=UpdateOrderSchema,
    path="/orders",
    tags=["Orders", "Sales"]
)

Integrating Multiple Models: 

product_router = crud_router(
    session=async_session,
    model=ProductModel,
    crud=CRUDProductModel(ProductModel),
    create_schema=CreateProductSchema,
    update_schema=UpdateProductSchema,
    path="/products",
    tags=["Inventory"]
)

customer_router = crud_router(
    session=async_session,
    model=CustomerModel,
    crud=CRUDCustomerModel(CustomerModel),
    create_schema=CreateCustomerSchema,
    update_schema=UpdateCustomerSchema,
    path="/customers",
    tags=["CRM"]
)

With Selective CRUD Methods: 

# Only include 'create' and 'read' methods
router = crud_router(
    session=async_session,
    model=MyModel,
    crud=CRUDMyModel(MyModel),
    create_schema=CreateMyModel,
    update_schema=UpdateMyModel,
    included_methods=["create", "read"],
    path="/mymodel",
    tags=["MyModel"]
)

Using a Custom EndpointCreator: 

class CustomEndpointCreator(EndpointCreator):
    def _custom_route(self):
        async def custom_endpoint():
            # Custom endpoint logic
            return {"message": "Custom route"}

        return custom_endpoint

        async def add_routes_to_router(self, ...):
            # First, add standard CRUD routes
            super().add_routes_to_router(...)

            # Now, add custom routes
            self.router.add_api_route(
                path="/custom",
                endpoint=self._custom_route(),
                methods=["GET"],
                tags=self.tags,
                # Other parameters as needed
            )

router = crud_router(
    session=async_session,
    model=MyModel,
    crud=CRUDMyModel(MyModel),
    create_schema=CreateMyModel,
    update_schema=UpdateMyModel,
    endpoint_creator=CustomEndpointCreator,
    path="/mymodel",
    tags=["MyModel"]
)

app.include_router(my_router)

Customizing Endpoint Names: 

router = crud_router(
    session=async_session,
    model=TaskModel,
    create_schema=CreateTaskSchema,
    update_schema=UpdateTaskSchema,
    path="/tasks",
    tags=["Task Management"],
    endpoint_names={
        "create": "add_task",
        "read": "get_task",
        "update": "modify_task",
        "delete": "remove_task",
        "db_delete": "permanently_remove_task",
        "read_multi": "list_tasks",
        "read_paginated": "paginate_tasks"
    }
)

Using FilterConfig with dict: 

from fastapi import FastAPI
from fastcrud import crud_router
from myapp.models import MyModel
from myapp.schemas import CreateMyModel, UpdateMyModel
from myapp.database import async_session

app = FastAPI()

router = crud_router(
    session=async_session,
    model=MyModel,
    create_schema=CreateMyModel,
    update_schema=UpdateMyModel,
    filter_config=FilterConfig(filters={"id": None, "name": "default"})
)
# Adds CRUD routes with filtering capabilities
app.include_router(router, prefix="/mymodel")

# Explanation:
# The FilterConfig specifies that 'id' should be a query parameter with no default value
# and 'name' should be a query parameter with a default value of 'default'.
# When fetching multiple items, you can filter by these parameters.
# Example GET request: /mymodel/get_multi?id=1&name=example

Using FilterConfig with keyword arguments: 

from fastapi import FastAPI
from fastcrud import crud_router
from myapp.models import MyModel
from myapp.schemas import CreateMyModel, UpdateMyModel
from myapp.database import async_session

app = FastAPI()

router = crud_router(
    session=async_session,
    model=MyModel,
    create_schema=CreateMyModel,
    update_schema=UpdateMyModel,
    filter_config=FilterConfig(id=None, name="default")
)
# Adds CRUD routes with filtering capabilities
app.include_router(router, prefix="/mymodel")

# Explanation:
# The FilterConfig specifies that 'id' should be a query parameter with no default value
# and 'name' should be a query parameter with a default value of 'default'.
# When fetching multiple items, you can filter by these parameters.
# Example GET request: /mymodel/get_multi?id=1&name=example

Source code in fastcrud/endpoint/crud_router.py 
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
def crud_router(
    session: Callable,
    model: type[DeclarativeBase],
    create_schema: Type[CreateSchemaType],
    update_schema: Type[UpdateSchemaType],
    crud: Optional[FastCRUD] = None,
    delete_schema: Optional[Type[DeleteSchemaType]] = None,
    path: str = "",
    tags: Optional[list[Union[str, Enum]]] = None,
    include_in_schema: bool = True,
    create_deps: Sequence[Callable] = [],
    read_deps: Sequence[Callable] = [],
    read_multi_deps: Sequence[Callable] = [],
    read_paginated_deps: Sequence[Callable] = [],
    update_deps: Sequence[Callable] = [],
    delete_deps: Sequence[Callable] = [],
    db_delete_deps: Sequence[Callable] = [],
    included_methods: Optional[list[str]] = None,
    deleted_methods: Optional[list[str]] = None,
    endpoint_creator: Optional[Type[EndpointCreator]] = None,
    is_deleted_column: str = "is_deleted",
    deleted_at_column: str = "deleted_at",
    updated_at_column: str = "updated_at",
    endpoint_names: Optional[dict[str, str]] = None,
    filter_config: Optional[Union[FilterConfig, dict]] = None,
) -> APIRouter:
    """
    Creates and configures a FastAPI router with CRUD endpoints for a given model.

    This utility function streamlines the process of setting up a router for CRUD operations,
    using a custom `EndpointCreator` if provided, and managing dependency injections as well
    as selective method inclusions or exclusions.

    Args:
        session: The SQLAlchemy async session.
        model: The SQLAlchemy model.
        crud: An optional FastCRUD instance. If not provided, uses FastCRUD(model).
        create_schema: Pydantic schema for creating an item.
        update_schema: Pydantic schema for updating an item.
        delete_schema: Optional Pydantic schema for deleting an item.
        path: Base path for the CRUD endpoints.
        tags: Optional list of tags for grouping endpoints in the documentation.
        include_in_schema: Whether to include the created endpoints in the OpenAPI schema.
        create_deps: Optional list of functions to be injected as dependencies for the create endpoint.
        read_deps: Optional list of functions to be injected as dependencies for the read endpoint.
        read_multi_deps: Optional list of functions to be injected as dependencies for the read multiple items endpoint.
        update_deps: Optional list of functions to be injected as dependencies for the update endpoint.
        delete_deps: Optional list of functions to be injected as dependencies for the delete endpoint.
        db_delete_deps: Optional list of functions to be injected as dependencies for the hard delete endpoint.
        included_methods: Optional list of CRUD methods to include. If None, all methods are included.
        deleted_methods: Optional list of CRUD methods to exclude.
        endpoint_creator: Optional custom class derived from EndpointCreator for advanced customization.
        is_deleted_column: Optional column name to use for indicating a soft delete. Defaults to "is_deleted".
        deleted_at_column: Optional column name to use for storing the timestamp of a soft delete. Defaults to "deleted_at".
        updated_at_column: Optional column name to use for storing the timestamp of an update. Defaults to "updated_at".
        endpoint_names: Optional dictionary to customize endpoint names for CRUD operations. Keys are operation types
                        ("create", "read", "update", "delete", "db_delete", "read_multi", "read_paginated"), and
                        values are the custom names to use. Unspecified operations will use default names.
        filter_config: Optional FilterConfig instance or dictionary to configure filters for the `read_multi` and `read_paginated` endpoints.

    Returns:
        Configured APIRouter instance with the CRUD endpoints.

    Raises:
        ValueError: If both 'included_methods' and 'deleted_methods' are provided.

    Examples:
        Basic Setup:
        ```python
        router = crud_router(
            session=async_session,
            model=MyModel,
            create_schema=CreateMyModelSchema,
            update_schema=UpdateMyModelSchema,
            path="/mymodel",
            tags=["MyModel"]
        )
        ```

        With Custom Dependencies:
        ```python
        def get_current_user(token: str = Depends(oauth2_scheme)):
            # Implement user retrieval logic
            return ...

        router = crud_router(
            session=async_session,
            model=UserModel,
            create_schema=CreateUserSchema,
            update_schema=UpdateUserSchema,
            read_deps=[get_current_user],
            update_deps=[get_current_user],
            path="/users",
            tags=["Users"]
        )
        ```

        Adding Delete Endpoints:
        ```python
        router = crud_router(
            session=async_session,
            model=ProductModel,
            create_schema=CreateProductSchema,
            update_schema=UpdateProductSchema,
            delete_schema=DeleteProductSchema,
            path="/products",
            tags=["Products"]
        )
        ```

        Customizing Path and Tags:
        ```python
        router = crud_router(
            session=async_session,
            model=OrderModel,
            crud=CRUDOrderModel(OrderModel),
            create_schema=CreateOrderSchema,
            update_schema=UpdateOrderSchema,
            path="/orders",
            tags=["Orders", "Sales"]
        )
        ```

        Integrating Multiple Models:
        ```python
        product_router = crud_router(
            session=async_session,
            model=ProductModel,
            crud=CRUDProductModel(ProductModel),
            create_schema=CreateProductSchema,
            update_schema=UpdateProductSchema,
            path="/products",
            tags=["Inventory"]
        )

        customer_router = crud_router(
            session=async_session,
            model=CustomerModel,
            crud=CRUDCustomerModel(CustomerModel),
            create_schema=CreateCustomerSchema,
            update_schema=UpdateCustomerSchema,
            path="/customers",
            tags=["CRM"]
        )
        ```

        With Selective CRUD Methods:
        ```python
        # Only include 'create' and 'read' methods
        router = crud_router(
            session=async_session,
            model=MyModel,
            crud=CRUDMyModel(MyModel),
            create_schema=CreateMyModel,
            update_schema=UpdateMyModel,
            included_methods=["create", "read"],
            path="/mymodel",
            tags=["MyModel"]
        )
        ```

        Using a Custom EndpointCreator:
        ```python
        class CustomEndpointCreator(EndpointCreator):
            def _custom_route(self):
                async def custom_endpoint():
                    # Custom endpoint logic
                    return {"message": "Custom route"}

                return custom_endpoint

                async def add_routes_to_router(self, ...):
                    # First, add standard CRUD routes
                    super().add_routes_to_router(...)

                    # Now, add custom routes
                    self.router.add_api_route(
                        path="/custom",
                        endpoint=self._custom_route(),
                        methods=["GET"],
                        tags=self.tags,
                        # Other parameters as needed
                    )

        router = crud_router(
            session=async_session,
            model=MyModel,
            crud=CRUDMyModel(MyModel),
            create_schema=CreateMyModel,
            update_schema=UpdateMyModel,
            endpoint_creator=CustomEndpointCreator,
            path="/mymodel",
            tags=["MyModel"]
        )

        app.include_router(my_router)
        ```

        Customizing Endpoint Names:
        ```python
        router = crud_router(
            session=async_session,
            model=TaskModel,
            create_schema=CreateTaskSchema,
            update_schema=UpdateTaskSchema,
            path="/tasks",
            tags=["Task Management"],
            endpoint_names={
                "create": "add_task",
                "read": "get_task",
                "update": "modify_task",
                "delete": "remove_task",
                "db_delete": "permanently_remove_task",
                "read_multi": "list_tasks",
                "read_paginated": "paginate_tasks"
            }
        )
        ```

        Using FilterConfig with dict:
        ```python
        from fastapi import FastAPI
        from fastcrud import crud_router
        from myapp.models import MyModel
        from myapp.schemas import CreateMyModel, UpdateMyModel
        from myapp.database import async_session

        app = FastAPI()

        router = crud_router(
            session=async_session,
            model=MyModel,
            create_schema=CreateMyModel,
            update_schema=UpdateMyModel,
            filter_config=FilterConfig(filters={"id": None, "name": "default"})
        )
        # Adds CRUD routes with filtering capabilities
        app.include_router(router, prefix="/mymodel")

        # Explanation:
        # The FilterConfig specifies that 'id' should be a query parameter with no default value
        # and 'name' should be a query parameter with a default value of 'default'.
        # When fetching multiple items, you can filter by these parameters.
        # Example GET request: /mymodel/get_multi?id=1&name=example
        ```

        Using FilterConfig with keyword arguments:
        ```python
        from fastapi import FastAPI
        from fastcrud import crud_router
        from myapp.models import MyModel
        from myapp.schemas import CreateMyModel, UpdateMyModel
        from myapp.database import async_session

        app = FastAPI()

        router = crud_router(
            session=async_session,
            model=MyModel,
            create_schema=CreateMyModel,
            update_schema=UpdateMyModel,
            filter_config=FilterConfig(id=None, name="default")
        )
        # Adds CRUD routes with filtering capabilities
        app.include_router(router, prefix="/mymodel")

        # Explanation:
        # The FilterConfig specifies that 'id' should be a query parameter with no default value
        # and 'name' should be a query parameter with a default value of 'default'.
        # When fetching multiple items, you can filter by these parameters.
        # Example GET request: /mymodel/get_multi?id=1&name=example
        ```
    """
    crud = crud or FastCRUD(
        model=model,
        is_deleted_column=is_deleted_column,
        deleted_at_column=deleted_at_column,
        updated_at_column=updated_at_column,
    )

    endpoint_creator_class = endpoint_creator or EndpointCreator
    endpoint_creator_instance = endpoint_creator_class(
        session=session,
        model=model,
        crud=crud,
        create_schema=create_schema,
        update_schema=update_schema,
        include_in_schema=include_in_schema,
        delete_schema=delete_schema,
        path=path,
        tags=tags,
        is_deleted_column=is_deleted_column,
        deleted_at_column=deleted_at_column,
        updated_at_column=updated_at_column,
        endpoint_names=endpoint_names,
        filter_config=filter_config,
    )

    endpoint_creator_instance.add_routes_to_router(
        create_deps=create_deps,
        read_deps=read_deps,
        read_multi_deps=read_multi_deps,
        read_paginated_deps=read_paginated_deps,
        update_deps=update_deps,
        delete_deps=delete_deps,
        db_delete_deps=db_delete_deps,
        included_methods=included_methods,
        deleted_methods=deleted_methods,
    )

    return endpoint_creator_instance.router