言語
日本語
English

Caution

お使いのブラウザはJavaScriptが無効になっております。
当サイトでは検索などの処理にJavaScriptを使用しています。
より快適にご利用頂くため、JavaScriptを有効にしたうえで当サイトを閲覧することをお勧めいたします。

  1. トップページ
  2. FastAPI辞典

FastAPI辞典 一覧ページ

初心者向け: 概要と特徴、学習順ガイド型ヒント・Pydantic・非同期処理の関係と推奨学習順の案内。
【環境構築】FastAPI Dictionaryの開発環境Python・pip・uvicornによる開発環境の構築手順。
APIRouterエンドポイントをモジュール単位に分割して管理するルーター。
app.delete()HTTP DELETEリクエストを処理するパスオペレーションのデコレーター。
@app.get()HTTP GETリクエストを受け取るパスオペレーションのデコレーター。
app.patch()HTTP PATCHリクエストを処理するパスオペレーションのデコレーター。
app.post()HTTP POSTリクエストを処理するパスオペレーションのデコレーター。
app.put()HTTP PUTリクエストを処理するパスオペレーションのデコレーター。
非同期処理(async / await)async defとawaitによるノンブロッキングなI/O処理の実装。
BackgroundTasksレスポンス返却後に非同期でタスクを実行する仕組み。
BaseModel継承してリクエスト・レスポンスのデータ構造を型安全に定義する基底クラス。
Body()リクエストボディパラメーターにバリデーションやメタデータを付与する関数。
Cookie()HTTPリクエストのCookie値を関数の引数として受け取る関数。
レスポンスのCookie設定レスポンスのCookieを付与・削除する操作方法。
CORSCORSMiddlewareで異なるオリジンからのリクエストを許可する設定。
DatabaseSQLAlchemy + Depends()によるDBセッション管理パターン。
Depends()認証・DBセッションなどの共通処理をエンドポイントへ自動注入する仕組み。
EnumパラメーターEnumクラスで受け付ける値を特定の選択肢に制限するパラメーター型。
Field()Pydanticモデルのフィールドにバリデーションとメタデータを設定する関数。
File()アップロードファイルをbytes型で受け取るパラメーター宣言関数。
FileResponseサーバー上のファイルをダウンロード用に非同期送信するレスポンスクラス。
Form()HTMLフォーム送信データをパラメーターとして受け取る宣言関数。
Header()HTTPリクエストのヘッダー値を関数の引数として受け取る関数。
HTMLResponseHTML文字列をそのままHTTPレスポンスとして返すクラス。
HTTPException任意のHTTPステータスとエラーメッセージを持つレスポンスを発生させる例外。
JSONResponseステータスコードとヘッダーを細かく制御してJSONを返すクラス。
lifespan(起動・終了イベント)アプリの起動時と終了時に初期化・クリーンアップを実行する仕組み。
Middlewareリクエスト受信後とレスポンス送信前に共通処理を挿入する仕組み。
@model_validatorPydanticモデル全体に対するバリデーションを定義するデコレーター。
OAuth2 / セキュリティOAuth2フローに沿ったトークンベースの認証・認可の実装方法。
OpenAPI / Swagger UI/docsと/redocで自動生成されるインタラクティブなAPIドキュメント。
Path()パスパラメーターにバリデーションや範囲チェックを追加する関数。
Path ParametersURLパスの波括弧部分を型変換・バリデーション付きで受け取る仕組み。
Query()クエリパラメーターにデフォルト値・バリデーションを設定する関数。
Query Parameters?key=value形式のクエリパラメーターを関数の引数として受け取る仕組み。
RedirectResponseステータスコードを指定して任意のURLへリダイレクトするクラス。
Request BodyPydanticモデルでJSONボディを型安全に受け取る方法。
Response HeadersResponse引数を受け取ってカスタムHTTPヘッダーを付与する方法。
response_model(レスポンスモデル)レスポンス形式をPydanticモデルで定義するデコレーターパラメーター。
Settings (pydantic-settings)BaseSettingsで環境変数や.envから設定値を型付きで読み込む。
status_code(HTTPステータスコード)正常終了時のHTTPステータスをデコレーターで設定するパラメーター。
StreamingResponseイテラブルからデータを逐次送信するストリーミングレスポンスクラス。
タグとメタデータtagsパラメーターでAPIドキュメントのエンドポイントをグループ表示する方法。
TestClientサーバーを起動せずにエンドポイントをテストするhttpxベースのクライアント。
UploadFileアップロードファイルをストリームとして非同期アクセスするクラス。
@field_validator(バリデーター)Pydantic v2のフィールドバリデーターを定義するデコレーター。
WebSocketクライアントとサーバー間のリアルタイム双方向通信エンドポイントを定義する仕組み。