フォームまたは JSON 本文を受け入れる FastAPI エンドポイントを作成するにはどうすればよいですか?

フォームまたは JSON 本文を受け入れる FastAPI エンドポイントを作成するにはどうすればよいですか?

FastAPI では、次のようなさまざまなタイプのリクエスト本文を処理するエンドポイントを定義できます。 JSON またはフォームデータ。これにより、別個のエンドポイントを必要とせずに、どちらの形式も受け入れることができるエンドポイントを作成できます。

これを実現するには、以下のいずれかの方法に従います。

オプション 1: 依存関係関数を使用する

依存関係関数を利用してリクエストの Content-Type ヘッダーを検証し、Starlette のメソッドを使用して本文を適切に解析できます。 Content-Type ヘッダーのみに依存すると、リクエスト本文の有効性が常に保証されるとは限らないため、エラー処理を含めることをお勧めします。

<code class="python">import os, sys
from fastapi import FastAPI, Depends, HTTPException
from starlette.requests import Request
app = FastAPI()

# Generating file
open("./app.txt", "w").write("hello from a file")

async def body_parser(request: Request):
    ct = request.headers.get("Content-Type", "")
    if ct == "application/json":
        try:
            d = await request.json()
            if not isinstance(d, dict):
                raise HTTPException(status_code=400, details={"error":"request body must be a dict"})
            return d
        except JSONDecodeError:
            raise HTTPException(400, "Could not parse request body as JSON")
    elif ct == "multipart/form-data":
        await request.stream()  # this is required for body parsing.
        d = await request.form()
        if not d:
            raise HTTPException(status_code=400, details={"error":"no form parameters found"})
        return d
    else:
        raise HTTPException(405, "Content-Type must be either JSON or multipart/form-data")

@app.post("/", dependencies=[Depends(body_parser)])
async def body_handler(d: dict):
    if "file" in d:
        return {"file": d["file"]}
    return d</code>

オプション 2: オプションのフォーム/ファイル パラメーターを使用する

このアプローチでは、エンドポイントでフォーム/ファイルのパラメーターをオプションとして定義できます。これらのパラメーターのいずれかに値がある場合、フォーム データ リクエストとみなされます。それ以外の場合は、リクエスト本文を JSON として検証します。

<code class="python">from fastapi import FastAPI, Form, File, UploadFile
app = FastAPI()

@app.post("/")
async def file_or_json(
    files: List[UploadFile] = File(None),
    some_data: str = Form(None)
):
    if files:
        return {"files": len(files)}
    return {"data": some_data}</code>

オプション 3: タイプごとに個別のエンドポイントを定義する

JSON 用とフォームデータ用に 1 つずつ個別のエンドポイントを作成することもできます。 。ミドルウェアを使用すると、Content-Type ヘッダーを確認し、リクエストを適切なエンドポイントに再ルーティングできます。

<code class="python">from fastapi import FastAPI, Request, Form, File, UploadFile
from fastapi.responses import JSONResponse
app = FastAPI()

@app.middleware("http")
async def middleware(request: Request, call_next):
    ct = request.headers.get("Content-Type", "")
    if ct == "application/json":
        request.scope["path"] = "/json"
    elif ct in ["multipart/form-data", "application/x-www-form-urlencoded"]:
        request.scope["path"] = "/form"
    return await call_next(request)

@app.post("/json")
async def json_endpoint(json_data: dict):
    pass

@app.post("/form")
async def form_endpoint(file: UploadFile = File(...)):
    pass</code>

オプション 4: 代替アプローチについて別の回答を参照する

さらに、次のこともできます。 Stack Overflow のこの回答は、単一のエンドポイントでの JSON とフォームデータの両方の処理に関する異なる視点を提供するため、役に立ちます:

https://stackoverflow.com/a/67003163/10811840

テスト オプション 1、2、および 3

テスト目的で、リクエスト ライブラリを使用できます:

<code class="python">import requests

url = "http://127.0.0.1:8000"
# for testing Python 3.7 and above use:
# url = "http://localhost:8000"

# form-data request
files = [('files', ('a.txt', open('a.txt', 'rb'), 'text/plain'))]
response = requests.post(url, files=files)
print(response.text)

# JSON request
data = {"some_data": "Hello, world!"}
response = requests.post(url, json=data)
print(response.text)</code>

これらのアプローチでは、JSON とフォームの両方を処理できるエンドポイントを作成するさまざまな方法が提供されます。 -FastAPI のデータ。要件とユースケースに最適なアプローチを選択してください。

以上がフォームまたは JSON 本文を受け入れる FastAPI エンドポイントを作成するにはどうすればよいですか?の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。