FastAPI で同じパスパラメータを持つ複数の API エンドポイントを定義する

FastAPI で、同じパスパラメータで異なる複数の API エンドポイントを定義する道は単純ではありません。エンドポイント評価の順序が重要であるため、リクエストの特定のパスに関係なく、最初に定義されたエンドポイントが常にトリガーされます。

問題

次のルーターファイルについて考えてみましょう。ここで 3 つのエンドポイントが定義されており、それぞれ異なるパスを持ちますが、「project_id」パスパラメーターを共有しています:

</p>
<h1 id="GET-API-Endpoint">GET API Endpoint 1</h1>
<p>@router.get("/project/{project_id}/{employee_id}")<br>async def method_one(project_id: str,organization_id: str, session: AsyncSession = depends(get_db)):</p> <div class="code" style="position:relative; padding:0px; margin:0px;"><div class="code" style="position:relative; padding:0px; margin:0px;"><div class="code" style="position:relative; padding:0px; margin:0px;"><div class="code" style="position:relative; padding:0px; margin:0px;"><pre class="brush:php;toolbar:false"># ...

ログイン後にコピー

GET API エンドポイント 2

@router.get("/project/details/{project_id}")
async def method_two(project_id: str, session: AsyncSession = depends(get_db) )):

# ...

ログイン後にコピー

GET API エンドポイント 3

@router.get("/project/metadata/{project_id}")
async def method_three(project_id: str, session : AsyncSession = depends(get_db)):

# ...

ログイン後にコピー

このコードは、API エンドポイント 2 および 3 がエンドポイント 1 で定義されたコントローラーメソッド (method_one) を呼び出すときに予期しない動作を示します。 ()).

Reason

FastAPI では、エンドポイントの評価は順番に行われます。したがって、エンドポイント 1 (「/project/{project_id}/{employee_id}」) が最初に評価されます。後続のリクエストがエンドポイント 2 またはエンドポイント 3 に対して行われると、FastAPI はパスの「/project/{project_id}」部分をエンドポイント 1 の project_id パラメーターとして解釈します。これにより、エンドポイント 1 のコントローラーメソッドが呼び出されます。

解決策

この問題を解決するには、エンドポイント定義の順序を逆にして、同じパスパラメーターを持つエンドポイントが追加のパスを含むエンドポイントの前に定義されるようにする必要があります。パラメータ:

</p>
<h1 id="GET-API-エンドポイント">GET API エンドポイント 2</h1>
<p>@router.get("/project/details/{project_id} ")</p>
<div class="code" style="position:relative; padding:0px; margin:0px;"><div class="code" style="position:relative; padding:0px; margin:0px;"><div class="code" style="position:relative; padding:0px; margin:0px;"><div class="code" style="position:relative; padding:0px; margin:0px;"><pre class="brush:php;toolbar:false"># ...

ログイン後にコピー