fastapi-boot 0.0.50

FastAPI tools

FastAPIBoot

  简单易用、功能强大的FastAPI工具库，支持CBV、依赖注入、声明式公共路由依赖和生命周期等写法，为提高效率而生。

cbv: class based view

特点

• 📦无缝集成FastAPI，开箱即用，继承FastAPI的优点，支持通过CLI初始化。
• 🐎支持CBV、FBV，想套多少层就套多少层，路由层级关系更清晰。
• ✅ 践行IOC、DI、AOP，开发更高效。
• 🌈公共依赖提取，结合多层CBV，避免endpoint中大量的Depends。
• 🔨丰富的工具，生命周期、异常处理、中间件、tortoise工具。

1. 快速开始

1.1 安装

pip install fastapi-boot
# 或者使用uv
uv add fastapi-boot

1.2 和FastAPI比较

📌要实现这些接口

1. 用fastapi_boot

from typing import Annotated
from fastapi import Query
from fastapi_boot.core import Controller, Get, provide_app, Post
import uvicorn


# fbv, function based view
@Get('/r1')
def top_level_fbv1():
    return '/r1'


# fbv
@Controller('/r2').get('')
def top_level_fbv2():
    return '/r2'


# cbv, class based view
@Controller('/r3')
class CBVController:
    @Get('/1')
    async def cbv_endpoint1(self):
        return '/r3/1'

    @Post('/2')
    def cbv_endpoint2(self, q: Annotated[str, Query()]):
        return dict(query=q, path='/r3/2')


app = provide_app(controllers=[top_level_fbv1, top_level_fbv2, CBVController])


if __name__ == '__main__':
    uvicorn.run('main:app', reload=True)

• 用fastapi

from typing import Annotated
from fastapi import APIRouter, FastAPI, Query
import uvicorn


app = FastAPI()

@app.get('/r1')
def endpoint1():
    return '/r1'


router1 = APIRouter(prefix='/r2')

@router1.get('')
def endpoint2():
    return '/r2'

app.include_router(router1)


router2 = APIRouter(prefix='/r3')

@router2.get('/1')
async def endpoint3():
    return '/r3/1'

@router2.post('/2')
def endpoint4(q: Annotated[str, Query()]):
    return dict(query=q, path='/r3/2')

app.include_router(router2)


if __name__ == '__main__':
    uvicorn.run('main:app', reload=True)

1.3 💡通过CLI生成：

fastapi-boot --host=localhost --port=8000 --reload --name=Demo

2. 所有API

from fastapi_boot.core import (
    Injectable,
    Bean,
    provide_app, 
    use_dep, 
    use_http_middleware, 
    use_ws_middleware, 
    inject.
    Controller,
    Delete,
    Get,
    Head,
    Options,
    Patch,
    Post,
    Prefix,
    Put,
    Req,
    Trace,
    WebSocket as WS,
)

# tortoise工具
from fastapi_boot.tortoise_util import Sql, Select, Update, Insert, Delete as SqlDelete