Giter Club home page Giter Club logo

fastapi-pagination's Introduction

logo

license test codecov downloads pypi black

Introduction

fastapi-pagination is a library that provides pagination feature for FastAPI applications.


For more information about library please see documentation.


Installation

pip install fastapi-pagination

Quickstart

All you need to do is to use Page class as a return type for your endpoint and call paginate function on data you want to paginate.

from fastapi import FastAPI
from pydantic import BaseModel, Field

# import all you need from fastapi-pagination
from fastapi_pagination import Page, add_pagination, paginate

app = FastAPI()  # create FastAPI app


class UserOut(BaseModel):  # define your model
    name: str = Field(..., example="Steve")
    surname: str = Field(..., example="Rogers")


users = [  # create some data
    # ...
]


@app.get('/users', response_model=Page[UserOut])  # use Page[UserOut] as response model
async def get_users():
    return paginate(users)  # use paginate function to paginate your data


add_pagination(app)  # important! add pagination to your app

Please, be careful when you work with databases, because default paginate will require to load all data in memory.

For instance, if you use SQLAlchemy you can use paginate from fastapi_pagination.ext.sqlalchemy module.

from fastapi_pagination.ext.sqlalchemy import paginate


@app.get('/users', response_model=Page[UserOut])
def get_users(db: Session = Depends(get_db)):
    return paginate(db.query(User).order_by(User.created_at))

For SQLAlchemy 2.0 style you can use paginate from fastapi_pagination.ext.sqlalchemy_future module.

from sqlalchemy import select
from fastapi_pagination.ext.sqlalchemy_future import paginate


@app.get('/users', response_model=Page[UserOut])
def get_users(db: Session = Depends(get_db)):
    return paginate(db, select(User).order_by(User.created_at))

Currently, fastapi-pagination supports:

Library paginate function
SQLAlchemy fastapi_pagination.ext.sqlalchemy.paginate
SQLAlchemy 2.0 style fastapi_pagination.ext.sqlalchemy_future.paginate
Async SQLAlchemy 2.0 style fastapi_pagination.ext.async_sqlalchemy.paginate
SQLModel fastapi_pagination.ext.sqlmodel.paginate
Async SQLModel fastapi_pagination.ext.async_sqlmodel.paginate
AsyncPG fastapi_pagination.ext.asyncpg.paginate
Databases fastapi_pagination.ext.databases.paginate
Django ORM fastapi_pagination.ext.django.paginate
GINO fastapi_pagination.ext.gino.paginate
ORM fastapi_pagination.ext.orm.paginate
ormar fastapi_pagination.ext.ormar.paginate
Piccolo fastapi_pagination.ext.piccolo.paginate
Pony ORM fastapi_pagination.ext.pony.paginate
Tortoise ORM fastapi_pagination.ext.tortoise.paginate
Beanie fastapi_pagination.ext.beanie.paginate
PyMongo fastapi_pagination.ext.pymongo.paginate
MongoEngine fastapi_pagination.ext.mongoengine.paginate
Motor fastapi_pagination.ext.motor.paginate

Code from Quickstart will generate OpenAPI schema as bellow:

app-example

fastapi-pagination's People

Contributors

alexander-n avatar arthurio avatar collerek avatar dependabot-preview[bot] avatar dependabot[bot] avatar devalv avatar fruch avatar harry-lees avatar ihnokim avatar jacek-rybak avatar johnthagen avatar jonra1993 avatar kigawas avatar lingster avatar markbaas avatar michaelbukachi avatar nikstuckenbrock avatar rushilsrivastava avatar tjc15b avatar uriyyo avatar xeryustc avatar zsltg avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.