A dynamic FastAPI router that automatically creates CRUD routes for your models
MIT License
Published by awtkns over 1 year ago
With the release of v0.8.6 fastapi-crudrouter now officially supports both Python 3.11 and has dropped official support for Python 3.6 . Keep an eye of for the next release (v.0.9) which will contain support for async SQLAlchemy (https://github.com/awtkns/fastapi-crudrouter/issues/122).
Big thanks to all contributors that made this possible!
Full Changelog: https://github.com/awtkns/fastapi-crudrouter/compare/v0.8.5...v0.8.6
Published by awtkns over 2 years ago
With the release of v0.8.5 fastapi-crudrouter now officially supports both Python 3.10 and typed python. This release also includes significant improvements to the documentation, test suite, and developer experience.
Keep an eye of for the next release which will contain support for async SQLAlchemy (#122).
Big thanks to all contributors that made this possible!
Full Changelog: https://github.com/awtkns/fastapi-crudrouter/compare/v0.8.0...v0.8.5
Published by awtkns over 3 years ago
With the release of v0.6.0 fastapi-crudrouter now supports Gino as an async backend! When generating routes, GinoCRUDRouter will automatically tie into your database using your Gino models. To use it, simply pass your Gino database model, a database reference, and your pydantic.
GinoCRUDRouter(
schema=MyPydanticModel,
db_model=MyModel,
db=db
)
Check out the docs for more details on how to use the GinoCRUDRouter.
Published by awtkns over 3 years ago
With the release of v0.7.0 fastapi-crudrouter now provides the ability to set custom dependencies on a per route basis; a much requested feature. Prior to this release, it was only possible to set dependencies for all the routes at once.
MemoryCRUDRouter(
schema=MySchema,
create_route=[Depends(user)],
delete_all_route=[Depends(admin)]
)
Shown above is a brief example on how limiting each route to specific access rights would work using this new feature. Check out the docs for more details.
Published by awtkns over 3 years ago
With the release of v0.6.0 fastapi-crudrouter now supports ormar as an async backend! When generating routes, the OrmarCRUDRouter will automatically tie into your database using your ormar models. To use it, simply pass your ormar database model as the schema.
OrmarCRUDRouter(
schema=MyPydanticModel,
paginate=25
)
Check out the docs for more details on how to use the OrmarCRUDRouter
.
Published by awtkns over 3 years ago
With the release of v0.5.0 all CRUDRouters now supports pagination. All "get all" routes now accept skip
and limit
query parameters allowing you to easily paginate your routes. By default, no limit is set on the number of items returned by your routes. Should you wish to limit the number of items that a client can request, it can be done as shown below.
CRUDRouter(
schema=MyPydanticModel,
paginate=25
)
Check out the docs on pagination for more information!
Published by awtkns over 3 years ago
Published by awtkns almost 4 years ago
Tired of rewriting the same generic CRUD routes? Need to rapidly prototype a feature for a presentation or a hackathon? Thankfully, fastapi-crudrouter has your back. As an extension to the APIRouter included with FastAPI, the FastAPI CRUDRouter will automatically generate and document your CRUD routes for you.
Documentation: https://fastapi-crudrouter.awtkns.com
Source Code: https://github.com/awtkns/fastapi-crudrouter
pip install fastapi_crudrouter
Below is a simple example of what the CRUDRouter can do. In just ten lines of code, you can generate all the crud routes you need for any model. A full list of the routes generated can be found here.
from pydantic import BaseModel
from fastapi import FastAPI
from fastapi_crudrouter import MemoryCRUDRouter as CRUDRouter
class Potato(BaseModel):
id: int
color: str
mass: float
app = FastAPI()
app.include_router(CRUDRouter(model=Potato))