Skip to main content

一个动态的 FastAPI 路由器,可自动为您的模型创建 CRUD 路由

项目描述

⚡ 以光速创建 CRUD 路由
动态 FastAPI 路由器,自动为您的模型创建 CRUD 路由

测试 文档 包版本 执照


文档https://fastapi-crudrouter.awtkns.com

源代码https://github.com/awtkns/fastapi-crudrouter


厌倦了重写通用 CRUD 路由?需要为演示或黑客马拉松快速制作原型?值得庆幸的是,fastapi-crudrouter 支持您。作为 FastAPI 包含的APIRouter的扩展,FastAPI CRUDRouter 将自动为您生成和记录您的 CRUD 路由,您所要做的就是传递您的模型,也许还有您的数据库连接。

FastAPI-CRUDRouter照明速度快,经过良好测试,可用于生产

安装

pip install fastapi-crudrouter

基本用法

下面是一个简单的例子,说明 CRUDRouter 可以做什么。只需十行代码,您就可以生成任何模型所需的所有 crud 路由。可以在此处找到生成的路线的完整列表。

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(schema=Potato))

高级用法

fastapi-crudrouter 提供了许多功能,可让您充分利用自动生成的 CRUD 路由。下面列出了一些亮点。

  • 自动分页(文档
  • 提供自定义创建和更新模式的能力(文档
  • 创建和更新模式的动态生成(文档
  • 能够添加、自定义或禁用特定路由 ( docs )
  • 对 FastAPI 依赖注入的本机支持(文档

支持的后端/ORM

fastapi-crudrouter 当前支持许多后端/ORM。下面列出了当前支持的后端。此列表可能会在未来的版本中增加。

OpenAPI 支持

默认情况下,CRUDRouter 生成的所有路由都将根据 OpenAPI 规范进行记录。

下面是生成的 OpenAPI 文档中显示的 CRUDRouter 创建的默认路由。

OpenAPI 路由概览

CRUDRouter 能够根据给定的模型动态生成详细的文档。

OpenAPI 路由详情

下载文件

下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。

源分布

fastapi-crudrouter-0.8.5.tar.gz (9.6 kB 查看哈希

已上传 source

内置分布

fastapi_crudrouter-0.8.5-py3-none-any.whl (16.2 kB 查看哈希

已上传 py3