FastAPIの基本
FastAPIのコードを書く前に、デコレータというPythonの仕組みについて説明します。デコレータとは、関数の定義の直前に@記号を付けて記述し、その関数に追加の機能を付与する仕組みです。
1. デコレータとは
FastAPIのコードを書く前に、デコレータというPythonの仕組みについて説明します。デコレータとは、関数の定義の直前に@記号を付けて記述し、その関数に追加の機能を付与する仕組みです。
@デコレータ
def 関数名():
処理
@デコレータを関数の上に記述すると、その関数はデコレータによって追加の機能が付与されます。デコレータを使わない場合、同等の処理を実現するには関数の登録や設定を手動で書く必要がありますが、デコレータを使うことで簡潔に記述できます。
FastAPIでは、このデコレータの仕組みを使って「どのURLに対するリクエストを、どの関数で処理するか」を定義します。具体的な使い方は次のセクションで見ていきます。
2. ルーティングの基本
FastAPIでは、アプリケーションのインスタンスを作成し、デコレータでルーティングを定義します。ルーティングとは、リクエストのURLとHTTPメソッドに応じて、実行する関数を振り分ける仕組みです。
FastAPIにおけるリクエスト処理の流れを図に示します。
基本的な構文は以下のとおりです。
from fastapi import FastAPI
app = FastAPI()
@app.get("/パス")
def 関数名():
return {"キー": "値"}
FastAPI()でアプリケーションのインスタンスを作成し、@app.get()デコレータでHTTPメソッドとパスを指定します。関数が返す辞書型のデータは、自動的にJSON形式に変換されてレスポンスとして返されます。
実際に試してみましょう。作成したmain.pyに以下の内容を記述して保存します。
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
def root():
return {"message": "Hello World"}
このコードの各部分を説明します。
FastAPI()でアプリケーションのインスタンスを作成しています。このappオブジェクトが、APIのルーティングやリクエスト処理の中心となります。
@app.get("/")はデコレータで、ルートパス(/)に対するGETリクエストを処理する関数としてroot()を登録しています。
root()関数は辞書型のデータを返しています。FastAPIでは、辞書型を返すと自動的にJSON形式に変換してレスポンスが返されます。
| 💡 ポイント |
|---|
@app.get("/")のgetはHTTPメソッドのGETに対応しています。前のセクションで学んだPOST、PUT、DELETEに対応するデコレータとして、@app.post()、@app.put()、@app.delete()も用意されています。 |
3. サーバの起動
以下のコマンドでサーバを起動します。
uvicorn main:app --reload
このコマンドの各要素の意味は以下のとおりです。
| 要素 | 説明 |
|---|---|
main |
実行するPythonファイル名(main.pyのmain) |
app |
FastAPIのインスタンス変数名 |
--reload |
コード変更時に自動でサーバを再起動する(開発用) |
サーバが正常に起動すると、以下のメッセージが表示されます。
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO: Started reloader process [xxxxx] using StatReload
INFO: Started server process [xxxxx]
INFO: Waiting for application startup.
INFO: Application startup complete.
| 📝 ポート番号について |
|---|
FastAPI(uvicorn)のデフォルトポートは8000です。ポートを変更したい場合は--portオプションで指定できます(例: uvicorn main:app --reload --port 8080)。 |
4. 動作確認
別のターミナルウィンドウを開き、curlコマンドでリクエストを送信します。
curl http://localhost:8000/
以下のレスポンスが返されます。
{"message":"Hello World"}
root()関数が返した辞書型のデータが、JSON形式に変換されてレスポンスとして返されていることが確認できます。
ブラウザでhttp://localhost:8000/にアクセスしても、同じJSONレスポンスを確認できます。
| 📝 curlコマンドとは |
|---|
| curlは、ターミナルからHTTPリクエストを送信するためのコマンドラインツールです。APIの動作確認によく使用されます。引数にURLを指定するだけで、そのURLに対してGETリクエストを送信できます。 |