Skip to content

v0.5.0 - Pagination

2021-03-07

🎉 Highlights

With the release of v0.5.0 all CRUDRouters now support 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!

✨ Features

  • Pagination Support #34
  • Ability to set custom update schemas @andreipopovici #31 #27
  • Better documentation of past releases #36

🐛 Bug Fixes

  • Prefixing not available for versions of fastapi below v0.62.0 #29 #30
  • Fixed an Import Issue SQLAlchemy and Integrity Errors @andreipopovici #33

v0.4.0 - Tortoise ORM Support

2021-02-02

✨Features

  • Full support for tortoise-orm #24
  • Dynamic pk/id types for get_one, delete_one, and update_one routes #26

🐛 Bug Fixes

  • Fixed the summary for the delete one route #16
  • Fixed import errors when certain packages are not installed #21
  • Improved SQLA type hinting

v0.3.0 - Initial Release

2021-01-04

🎉 Initial Release 🎉

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

Installation

pip install fastapi_crudrouter

Usage

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

Features

  • Automatic pydantic model based route generation and documentation (Docs)
  • Ability to customize any of the generated routes (Docs)
  • Authorization and FastAPI dependency support (Docs)
  • Support for both async and non-async relational databases using SQLAlchemy (Docs)
  • Extensive documentation.
  • And much more 😎

Future Plans

  • Pagination Support
  • MongoDB / non-relational database support
  • Community requested features

Note: Pre-release versions of this package are incompatible with this release due to the renaming of arguments for package consistency