FastAPIとは何か
FastAPIは、Pythonの非常に高速（高性能）、使いやすい、モダンな、高速（高生産性）のWebフレームワークです。FastAPIは、Python 3.6以降の型ヒントを使用してAPIを構築するためのフレームワークで、これによりエディタのサポート（補完、型チェックなど）が大幅に向上します。
FastAPIは、Starlette（Web部分）とPydantic（データ部分）に基づいています。これにより、FastAPIはStarletteの全機能（WebSocket、GraphQL、テンプレートなど）とPydanticの全機能（データバリデーション、シリアライゼーションなど）を利用できます。
FastAPIは、APIの開発を高速化し、エラーを減らし、直感的で簡単に使えるように設計されています。また、FastAPIは、自動的に対話式のAPIドキュメンテーションを生成します。
FastAPIは、Pythonの非同期処理をサポートしており、非同期/待機（async/await）構文を使用して非同期I/Oを行うことができます。これにより、FastAPIは非常に高いパフォーマンスを発揮します。
- FastAPIは、RESTful APIの開発に最適なフレームワークであり、現代のWebアプリケーションやマイクロサービスの開発に広く使用されています。
FastAPIでアプリケーションを作成する基本的な手順
FastAPIを使用してWebアプリケーションを作成する基本的な手順は以下の通りです。
- FastAPIのインストール: FastAPIはPythonのパッケージとして提供されており、pipを使用して簡単にインストールできます。以下のコマンドを実行します。
pip install fastapi
- FastAPIアプリケーションの作成: FastAPIアプリケーションはPythonのスクリプトとして作成します。以下は、最も基本的なFastAPIアプリケーションの例です。
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
def read_root():
return {"Hello": "World"}
-
ルーティングの設定: FastAPIでは、デコレータを使用してルーティングを設定します。上記の例では、ルートURL（”/”）にGETリクエストが来たときに
read_root関数が呼び出されます。 -
リクエストハンドラの作成: ルーティングに対応する関数（リクエストハンドラ）を作成します。これらの関数は、リクエストを処理し、レスポンスを生成します。
-
アプリケーションの実行: FastAPIアプリケーションはASGIサーバー上で実行されます。UvicornやHypercornなどのASGIサーバーを使用します。以下のコマンドでUvicornを使用してアプリケーションを実行します。
uvicorn main:app --reload
- 以上がFastAPIを使用してWebアプリケーションを作成する基本的な手順です。FastAPIは非常に柔軟性が高く、これらの基本的な手順をベースに、様々な機能を追加してカスタマイズすることが可能です。
FastAPIアプリケーションを特定のポートで実行する方法
FastAPIアプリケーションを特定のポートで実行するには、ASGIサーバー（例えばUvicorn）を使用してアプリケーションを起動する際に、ポート番号を指定します。
以下に、FastAPIアプリケーションをポート8000で実行するコマンドを示します。
uvicorn main:app --port 8000
このコマンドでは、main:appはFastAPIアプリケーションが定義されているPythonスクリプト（main.py）とFastAPIアプリケーションのインスタンス（app）を指しています。--port 8000はUvicornにポート8000でアプリケーションを実行するように指示しています。
なお、--reloadオプションを付けると、コードの変更があった場合に自動的にアプリケーションが再起動します。開発中に便利です。
uvicorn main:app --port 8000 --reload
- 以上がFastAPIアプリケーションを特定のポートで実行する方法です。これにより、複数のFastAPIアプリケーションを同じマシン上で異なるポートで実行することが可能になります。
複数のポートでFastAPIアプリケーションを実行する方法
複数のポートでFastAPIアプリケーションを実行するには、それぞれのアプリケーションを異なるポートで起動する必要があります。これは、各アプリケーションを別々のターミナルセッションで起動するか、またはバックグラウンドで各アプリケーションを起動することで実現できます。
以下に、2つのFastAPIアプリケーションをそれぞれポート8000と8001で実行する例を示します。
1つ目のターミナルで:
uvicorn main:app --port 8000
2つ目のターミナルで:
uvicorn main:app --port 8001
この方法では、同じマシン上で複数のFastAPIアプリケーションを同時に実行することができます。ただし、各アプリケーションは独立して動作し、他のアプリケーションの状態に影響を与えることはありません。
- なお、同じアプリケーションを複数のポートで実行する場合、それぞれのインスタンスは独立しているため、一方のインスタンスで行われた状態の変更（例えば、データベースの更新）は他方のインスタンスには反映されません。そのため、同じアプリケーションを複数のポートで実行する場合は、その点を考慮する必要があります。
FastAPIアプリケーションを特定のポートで実行する際の注意点
FastAPIアプリケーションを特定のポートで実行する際には、以下のような点に注意する必要があります。
-
ポートの利用状況: 既に他のアプリケーションやサービスで使用されているポートを指定すると、ポートの競合が発生し、FastAPIアプリケーションの起動に失敗します。そのため、使用するポートは他のアプリケーションやサービスによって使用されていないことを確認する必要があります。
-
特権ポート: 一部のポート（0から1023までのポート）は、特権ポート（またはウェルノウンポート）と呼ばれ、通常はシステムプロセスまたは管理者権限を持つプロセスによってのみバインドできます。これらのポートを使用する場合は、適切な権限が必要です。
-
ポートの範囲: ポート番号は0から65535までの範囲で指定する必要があります。この範囲外の値を指定すると、エラーが発生します。
-
ファイアウォールの設定: ファイアウォールの設定によっては、FastAPIアプリケーションが特定のポートでリッスンしていても、そのポートへの接続がブロックされる場合があります。そのため、ファイアウォールの設定を適切に行う必要があります。
-
同じアプリケーションを複数のポートで実行する場合の状態管理: 同じアプリケーションを複数のポートで実行する場合、それぞれのインスタンスは独立しているため、一方のインスタンスで行われた状態の変更（例えば、データベースの更新）は他方のインスタンスには反映されません。そのため、その点を考慮する必要があります。
- 以上がFastAPIアプリケーションを特定のポートで実行する際の注意点です。これらの点を考慮に入れて、FastAPIアプリケーションの設定と運用を行うことで、問題を避けることができます。
まとめ
この記事では、Pythonの高速なWebフレームワークであるFastAPIについて、特にアプリケーションを特定のポートで実行する方法に焦点を当てて解説しました。
まず、FastAPIの基本的な概念と特徴について説明しました。次に、FastAPIでアプリケーションを作成する基本的な手順を示しました。その後、FastAPIアプリケーションを特定のポートで実行する方法、複数のポートでFastAPIアプリケーションを実行する方法、そして特定のポートでFastAPIアプリケーションを実行する際の注意点について詳しく説明しました。
FastAPIは非常に強力で柔軟性の高いフレームワークであり、これらの知識を活用することで、より効率的で堅牢なWebアプリケーションを開発することが可能になります。FastAPIのさらなる可能性を引き出すために、公式ドキュメンテーションの詳細な読み込みと実践的な経験を積むことをお勧めします。
この記事がFastAPIの理解と使用に役立つことを願っています。Happy coding! 🚀
0件のコメント