FastAPIとPoetryを用いたPythonプロジェクトの立ち上げ

FastAPIとは

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

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

• 高速: NodeJSやGoと同等の非常に高速なパフォーマンス（StarletteとPydanticのおかげで）。
• 高速なコーディング: 開発者の生産性を約2〜3倍に向上させます。開発時間を大幅に短縮し、バグを減らし、開発者が直感的に何をすべきかを理解するのを助けます。
• 少ないバグ: デベロッパーが新しいバグを導入する可能性を減らします。システムがどのように動作するべきかについての明確な理解を助けます。
• 直感的: 優れたエディタのサポート。自動補完がすべての場所で機能します。これにより、必要な時間が大幅に短縮されます。
• 簡単: 高度に直感的で使いやすい設計を目指して設計されています。ドキュメンテーションを読む時間を最小限に抑えることができます。
• 短い: コードの重複を最小限に抑え、複数の機能を持つパラメータを持つことができます。これにより、バグを導入する可能性が減ります。
• 堅牢: コードの生産準備が整っています。自動対話式ドキュメンテーションを含む。
• 基準に基づく: OpenAPI（以前はSwagger）とJSONスキーマに完全に準拠しています。
• Pythonic: FastAPIは、Pythonの型ヒントを使用して、エディタのサポート、型チェックなどのすべての利点を提供します。これは、Pythonの最新の言語機能を使用して設計されています。

Poetryとは

PoetryはPythonの依存関係管理とパッケージングを簡単にするためのツールです。pyproject.tomlファイルを使用して、プロジェクトの設定を一元化します。

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

• 依存関係管理: Poetryはプロジェクトの依存関係を追跡し、必要なパッケージを自動的にインストールします。
• パッケージング: Poetryはプロジェクトをパッケージ化し、他の人が使用できるようにします。これには、プロジェクトのメタデータと依存関係が含まれます。
• バージョン管理: Poetryはセマンティックバージョニングをサポートしており、プロジェクトのバージョンを簡単に管理できます。
• 仮想環境: PoetryはプロジェクトごとにPythonの仮想環境を自動的に作成します。これにより、プロジェクト間での依存関係の衝突を防ぐことができます。

これらの機能により、PoetryはPythonプロジェクトのライフサイクルを管理するための強力なツールとなっています。開発者はコードに集中することができ、Poetryが残りの部分を処理します。

FastAPIとPoetryのインストール

FastAPIとPoetryをインストールするには、以下の手順を実行します。

まず、Pythonがインストールされていることを確認します。Pythonのバージョンは3.6以上である必要があります。

次に、Poetryをインストールします。以下のコマンドを実行します：

curl -sSL https://install.python-poetry.org | python -

このコマンドは、Poetryのインストーラをダウンロードし、システムにPoetryをインストールします。

次に、新しいPythonプロジェクトを作成します。以下のコマンドを実行します：

poetry new my_project

これにより、my_projectという名前の新しいディレクトリが作成されます。

ディレクトリに移動し、FastAPIをインストールします：

cd my_project
poetry add fastapi

これで、FastAPIとPoetryがインストールされ、新しいPythonプロジェクトが作成されました。次に、FastAPIアプリケーションの作成と設定に進みます。

FastAPIプロジェクトの初期設定

FastAPIプロジェクトを初期設定するには、以下の手順を実行します。

まず、FastAPIアプリケーションのための新しいPythonファイルを作成します。以下のコマンドを実行します：

touch main.py

次に、main.pyファイルを開き、FastAPIアプリケーションの基本的な構造を作成します。以下のコードを追加します：

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def read_root():
    return {"Hello": "World"}

このコードは、FastAPIアプリケーションを作成し、ルートURL（/）にGETリクエストがあった場合に{"Hello": "World"}を返すように設定します。

次に、FastAPIアプリケーションを実行するためのコマンドを追加します。pyproject.tomlファイルを開き、以下の内容を追加します：

[tool.poetry.scripts]
start = "uvicorn main:app --reload"

これで、FastAPIアプリケーションの初期設定が完了しました。次に、FastAPIアプリケーションの作成と設定に進みます。

FastAPIアプリケーションの作成

FastAPIアプリケーションを作成するには、以下の手順を実行します。

まず、新しいエンドポイントを作成します。これは、特定のURLに対するHTTPリクエストを処理するためのものです。以下のコードをmain.pyに追加します：

@app.get("/items/{item_id}")
def read_item(item_id: int, q: str = None):
    return {"item_id": item_id, "q": q}

このコードは、/items/{item_id}というURLにGETリクエストがあった場合に、item_idとオプションのクエリパラメータqを返す新しいエンドポイントを作成します。

次に、FastAPIアプリケーションを実行します。以下のコマンドを実行します：

poetry run start

これで、FastAPIアプリケーションが起動し、http://localhost:8000でアクセスできます。また、http://localhost:8000/docsで自動生成されたAPIドキュメンテーションを確認できます。

以上で、FastAPIアプリケーションの作成が完了しました。次に、FastAPIアプリケーションのテストとデプロイに進みます。これらのステップは、FastAPIアプリケーションのライフサイクルの重要な部分であり、アプリケーションが正しく機能していることを確認し、ユーザーが使用できるようにするために必要です。これらのトピックについては、別の記事で詳しく説明します。この記事がFastAPIとPoetryの基本的な使用方法の理解に役立ったことを願っています。それでは、Happy Coding！