fastapi crudrouter

⚡ 超高速で CRUD ルートを作成します⚡
_{モデルの CRUD ルートを自動的に作成する動的 FastAPI ルーター}

---

ドキュメント: 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 でできることの簡単な例です。わずか 10 行のコードで、あらゆるモデルに必要なすべての 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 ルートを最大限に活用できるようにする多くの機能を提供します。以下にいくつかのハイライトを示します。

• 自動ページネーション (ドキュメント)
• カスタムのスキーマ作成および更新を提供する機能 (ドキュメント)
• スキーマの作成および更新の動的生成 (ドキュメント)
• 特定のルートを追加、カスタマイズ、または無効にする機能 (ドキュメント)
• FastAPI 依存関係インジェクションのネイティブ サポート (ドキュメント)

サポートされているバックエンド/ORM

fastapi-crudrouter は現在、多数のバックエンド/ORM をサポートしています。現在サポートされているバックエンドを以下に示します。このリストは将来のリリースでさらに増える可能性があります。

• メモリ内 (ドキュメント)
• SQLAlchemy (ドキュメント)
• データベース (非同期) (ドキュメント)
• Gino (非同期) (ドキュメント)
• Ormar (非同期) (ドキュメント)
• Tortoise ORM (非同期) (ドキュメント)

OpenAPIのサポート

デフォルトでは、CRUDRouter によって生成されたすべてのルートは OpenAPI 仕様に従って文書化されます。

以下は、生成された OpenAPI ドキュメントに示されている CRUDRouter によって作成されたデフォルト ルートです。

CRUDRouter は、与えられたモデルに基づいて詳細なドキュメントを動的に生成できます。