FastAPIでリクエストからボディを取得する方法

FastAPIとは

FastAPIは、Pythonの非常に高速（高性能）、使いやすい、モダンな、高速（クイック）なWebフレームワークです。これは、Python 3.6以降の型ヒントに基づいています。

FastAPIは、APIを構築するための最新のツールと最良のプラクティスを組み合わせています。これにより、非常に直感的で、使いやすく、生産性が高く、標準準拠のWeb APIを作成できます。

主な特徴は次のとおりです：

• 高速: Starlette（Web部分）とPydantic（データ部分）に基づいています。これは、NodeJSやGoと比較しても非常に高速です。
• 高速なコーディング: 約2〜3倍の開発速度を提供します。開発者の経験、エディタのサポート、以前の要件などによりますが、通常、2倍以上の速度で開発できます。
• 少ないバグ: 開発者が新しいバグを作成する可能性を減らします。これは、エディタのサポート、早期エラー、ショートカットなどによります。
• 直感的: 優れたエディタのサポート。新しいコードの補完。少ない時間でデバッグ。
• 簡単: 設計が簡単で、使いやすい。ドキュメンテーションが豊富。
• 短い: コードの重複を最小限に抑えます。各パラメータ宣言は一度だけ。パラメータの変換やバリデーションなど。
• 堅牢: コードが正しく動作していることを得るための準備が整っています。テストの準備が整っています。
• 標準準拠: OpenAPI（以前はSwagger）とJSON Schemaに完全準拠。
• JSONベース: JSONリクエストとレスポンスを読み書きするための準備が整っています。
• Pydanticベース: Pydanticモデルを使用して、データの変換、バリデーション、ドキュメンテーションなどを行います。
• Starletteベース: StarletteのASGIフレームワークを使用して、HTTP/2とWebSocketsのサポートを提供します。
• WebSocketベース: WebSocketルーティングとブロードキャストをサポートします。
• GraphQLベース: GraphQLルーティングと操作をサポートします。
• CORS、GZip、静的ファイル、ストリーミング応答など、完全なサポート。
• セッションとクッキーのサポート。
• 100％テストカバレッジ：プロジェクトは、すべてのコードがテストされていることを保証します。
• 100％型注釈カバレッジ：プロジェクトは、すべての関数が型注釈を持っていることを保証します。新しいバグを防ぎます！

リクエストからボディを取得する基本的な方法

HTTPリクエストのボディは、クライアントがサーバーに送信するデータを含んでいます。このデータは、フォームの入力、JSONデータ、ファイルのアップロードなど、さまざまな形式で送信できます。

PythonのWebフレームワークを使用している場合、リクエストオブジェクトからボディデータを取得する方法は通常、フレームワークによって提供されます。以下に、一般的な方法を示します。

フォームデータの取得

フォームから送信されたデータは、通常、application/x-www-form-urlencodedまたはmultipart/form-dataエンコーディングを使用してエンコードされます。これらのデータは、リクエストのボディに含まれ、キーと値のペアとして表現されます。

form_data = request.form

JSONデータの取得

JSONデータは、application/jsonエンコーディングを使用してエンコードされます。これらのデータもリクエストのボディに含まれます。

json_data = request.json()

ファイルのアップロード

ファイルのアップロードは、通常、multipart/form-dataエンコーディングを使用して行われます。これらのデータは、リクエストのボディに含まれ、ファイルの内容とメタデータ（ファイル名、タイプなど）を含みます。

uploaded_file = request.files['file_key']

これらの方法は一般的なものであり、使用しているフレームワークやライブラリによって異なる場合があります。具体的な使用方法については、該当するフレームワークのドキュメンテーションを参照してください。次のセクションでは、FastAPIでこれらの操作をどのように行うかについて説明します。

FastAPIでのリクエストボディの取得

FastAPIでは、リクエストボディを取得するための非常に直感的な方法が提供されています。Pythonの型ヒントを使用してリクエストボディを定義し、FastAPIが自動的にリクエストを解析し、適切な型に変換します。

以下に、FastAPIを使用してリクエストボディを取得する基本的な例を示します。

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Item(BaseModel):
    name: str
    description: str = None
    price: float
    tax: float = None

@app.post("/items/")
async def create_item(item: Item):
    item_dict = item.dict()
    if item.tax:
        price_with_tax = item.price + item.tax
        item_dict.update({"price_with_tax": price_with_tax})
    return item_dict

この例では、Itemという名前のPydanticモデルを定義しています。このモデルは、リクエストボディの形状を定義します。各フィールドは、特定の型（strやfloat）を持ち、一部のフィールドはデフォルト値（None）を持っています。

create_item関数は、/items/エンドポイントにPOSTリクエストを行うと呼び出されます。この関数は、Item型のパラメータitemを取ります。FastAPIは、送信されたリクエストボディをItemモデルに自動的に変換します。

このように、FastAPIを使用すると、リクエストボディの取得とバリデーションが非常に簡単になります。また、この方法は、リクエストボディがJSON形式であることを前提としています。他の形式（例えば、フォームデータやマルチパートデータ）を扱う方法については、FastAPIのドキュメンテーションを参照してください。

リクエストボディの取得と利用

FastAPIを使用してリクエストボディを取得した後、そのデータは通常、何らかの処理や操作のために使用されます。以下に、リクエストボディの取得と利用の基本的な例を示します。

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Item(BaseModel):
    name: str
    description: str = None
    price: float
    tax: float = None

@app.post("/items/")
async def create_item(item: Item):
    item_dict = item.dict()
    if item.tax:
        price_with_tax = item.price + item.tax
        item_dict.update({"price_with_tax": price_with_tax})
    return item_dict

この例では、create_item関数は、リクエストボディをItemモデルに変換し、そのデータを利用して新しいアイテムを作成します。具体的には、アイテムの価格と税金を加算して、税込み価格を計算します。そして、その結果をレスポンスとして返します。

このように、FastAPIとPydanticを使用すると、リクエストボディの取得と利用が非常に簡単になります。また、型ヒントと自動バリデーションにより、コードはより安全で、バグを導入する可能性が減少します。これにより、開発者はより重要なタスクに集中することができます。これは、FastAPIが高速なコーディングと少ないバグを実現する方法の一部です。次のセクションでは、これらの概念をさらに詳しく説明します。

まとめ

FastAPIは、Pythonの高速（高性能）、使いやすい、モダンな、高速（クイック）なWebフレームワークです。その主な特徴は、高速なコーディング、少ないバグ、直感的な操作、簡単な設計、短いコード、堅牢な構造、標準準拠、JSONベース、Pydanticベース、Starletteベース、WebSocketベース、GraphQLベース、CORS、GZip、静的ファイル、ストリーミング応答などの完全なサポート、セッションとクッキーのサポート、100％テストカバレッジ、100％型注釈カバレッジなどです。

FastAPIを使用すると、リクエストボディの取得と利用が非常に簡単になります。Pythonの型ヒントと自動バリデーションにより、コードはより安全で、バグを導入する可能性が減少します。これにより、開発者はより重要なタスクに集中することができます。

この記事では、FastAPIとそのリクエストボディの取得と利用について説明しました。FastAPIは、APIを構築するための強力なツールであり、その使いやすさと柔軟性により、PythonのWeb開発の新たなスタンダードとなりつつあります。FastAPIを使用すれば、あなたも高品質なWeb APIを効率的に構築できるでしょう。それでは、Happy coding！