fastapi-simple-crud 0.0.7

Generate CRUD routers for you schema in a simple way

FastAPI Simple CRUD Generator

Repository

• GITHUB

Installation

pip install fastapi-simple-crud

Description

A package to generate a CRUD routers and endpoints in a very simple way. Based on SQLAlchemy asynchronous operation and schema.

How to use ?

from fastapi import FastAPI
from sqlalchemy import Column, ForeignKey, Integer, String
from sqlalchemy.orm import sessionmaker, relationship
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine

from fastapi_simple_crud import SimpleCRUDGenerator, RouterMap

engine = create_async_engine("sqlite+aiosqlite:///./test.db", echo=True, future=True)
async_session = sessionmaker(engine, class_=AsyncSession, expire_on_commit=False)
Base = declarative_base()

async def get_session() -> AsyncSession:
    async with async_session() as session:
        yield session

class Country(Base):
    __tablename__ = "country"
    id = Column(Integer, primary_key=True, index=True, autoincrement=True)
    name = Column(String(100), nullable=False)

class President(Base):
    __tablename__ = "president"
    id = Column(Integer, primary_key=True, index=True)
    name = Column(String, nullable=False)
    country_id = Column(Integer, ForeignKey("country.id"))
    country = relationship("Country")

class People(Base):
    __tablename__ = "people"
    id = Column(Integer, primary_key=True, index=True)
    name = Column(String, nullable=False)
    age = Column(Integer)
    country_id = Column(Integer, ForeignKey("country.id"))
    country = relationship("Country")

app = FastAPI()

@app.on_event("startup")
async def startup():
    async with engine.begin() as conn:
        await conn.run_sync(Base.metadata.create_all)


## ULTRA SIMPLE OH MY GOD!

MyMap = RouterMap.create_router_map_from_base(base=Base)

crudGenerator = SimpleCRUDGenerator(application=app, session_getter=get_session)

Results

• your endpoints
  • 
• your pydantic schema
  • 

Example 2 : With RouterMap

from fastapi_simple_crud import SimpleCRUDGenerator, RouterMap, SimpleRouter, SimpleEndpoint

## ULTRA SIMPLE OH MY GOD!

class MyPresidentPydantic(BaseModel):
    name: int

class MyMap(RouterMap):
    country = SimpleRouter(Country, prefix="/v1/country")
    president = SimpleRouter(President, prefix="/v1/president",
        crud_update=None,
        crud_create=SimpleEndpoint(pydantic_model=MyPresidentPydantic),
        crud_read=SimpleEndpoint("/custom_read"))

crudGenerator = SimpleCRUDGenerator(application=app, session_getter=get_session)

• This example shows how to use RouterMap as a superclass
• You could disable the endpoint generation by simply passing between these keyword arguments to 'None' in the SimpleRouter definition:
  • crud_create
  • crud_read
  • crud_update
  • crud_delete
  • disable_simple_crud (will forcely disable all crud generation)
• Only your defined router mapping inside you router map (in above example is MyMap class) will be generated. From the example, People router is not exist.
• SimpleEndpoint() refers to your HTTP method definition (GET/POST/PUT/DELETE) in the router decorator (ex: @router.get(), etc.)

Example 3 : Add Your Custom Endpoints

from fastapi import Depends
from sqlalchemy.future import select
from fastapi_simple_crud import SimpleCRUDGenerator, RouterMap, SimpleRouter, SimpleEndpoint

## ULTRA SIMPLE OH MY GOD!

class MyPresidentPydantic(BaseModel):
    name: int

class MyMap(RouterMap):
    country = SimpleRouter(Country, prefix="/v1/country", crud_read=None)
    president = SimpleRouter(President, prefix="/v1/president")

@MyMap.country.get("/custom_read")
async def get_country(id: int, session: AsyncSession = Depends(get_session)):
    query = select(Country).where(Country.id==id)
    data = await session.execute(query)
    data = data.scalars().first()
    return data

crudGenerator = SimpleCRUDGenerator(application=app, session_getter=get_session)

• You could use your router from the your router map as shown above

Example 4 : Router Overriding

from fastapi_simple_crud import SimpleCRUDGenerator, RouterMap, SimpleRouter, SimpleEndpoint

## ULTRA SIMPLE OH MY GOD!

MyMap = RouterMap.create_router_map_from_base(base=Base)

## you want to remove people from autogeneration

class NewMap(MyMap):
    people = SimpleRouter(People, disable_simple_crud=True)

crudGenerator = SimpleCRUDGenerator(application=app, session_getter=get_session)

or inherit from the RouterMap

class NewMap(RouterMap):
    people = SimpleRouter(People, disable_simple_crud=True)

or simply update from the RouterMap

people = SimpleRouter(People, disable_simple_crud=True)
RouterMap.update_map(people)