FastAPIを使用したREST APIとクライアントの作成

by mr_osson 投稿日:

FastAPIとは何か

FastAPIは、Python 3.8+に基づいてAPIを構築するためのモダンで高速なWebフレームワークです。主な特徴は以下の通りです：

  • 高速：非常に高いパフォーマンスを持ち、NodeJSやGoと同等の速度を持っています。これはStarletteとPydanticのおかげで、FastAPIは利用可能なPythonフレームワークの中でも最も高速なものの一つです。
  • 高速なコーディング：開発速度を約200%から300%向上させます。
  • 少ないバグ：開発者によるエラーを約40%削減します。
  • 直感的：エディタのサポートが素晴らしく、どこでも補完が可能です。これによりデバッグ時間が削減されます。
  • 簡単：使用や学習が容易になるように設計されています。これによりドキュメントを読む時間が削減されます。
  • 短い：コードの重複を最小限に抑えます。各パラメータ宣言から複数の機能が得られます。
  • 堅牢：本番環境で使用できるコードを自動的に取得します。対話型のドキュメンテーションが自動生成されます。
  • 標準に基づいた：APIのオープンスタンダード（OpenAPI（以前はSwaggerとして知られていました）とJSONスキーマ）に基づいており、完全に互換性があります。

FastAPIは2018年に初めてリリースされ、その使いやすさ、速度、堅牢性から開発者の間で急速に人気を博しています。FastAPIは、ASGI（Asynchronous Server Gateway Interface）サーバーと、データ検証とシリアライゼーションのための強力なPydanticライブラリの上に構築されています。

FastAPIでREST APIを作成する

FastAPIを使用してREST APIを作成する方法は以下の通りです。

1. FastAPIのインストール

FastAPIとuvicorn（ASGIサーバー）をインストールします。Python 3.6以上が必要です。

pip install fastapi uvicorn

2. APIのエンドポイントを定義する

main.pyを作成し、以下のようにプログラムを書きます。

from fastapi import FastAPI

app = FastAPI()

@app.get("/items/{item_id}")
async def read_item(item_id: int):
    return {"item_id": item_id}

上記のコードでは、/items/{item_id}というエンドポイントを作成しています。

3. APIのエンドポイントにアクセスする

APIのエンドポイントにアクセスするためには、HTTPリクエストを送信します。例えば、GETメソッドでitems/10にアクセスすると以下のようなレスポンスが返されます。

curl "http://localhost:8000/items/10"

上記のコマンドを実行すると、以下のようなレスポンスが出力されます。

{"item_id": 10}

4. FastAPIのアプリサーバを構築する

main.pyを以下のように編集します。

from fastapi import FastAPI

app = FastAPI()

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

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

APIにアクセスするには、Webブラウザのアドレスバーにhttp://localhost:8000/items/42?q=testと入力するか、curl等のコマンドラインツールを活用します。以下のようなJSONレスポンスが出力されます。

{"item_id": 42, "q": "test"}

以上が、FastAPIでREST APIを開発するための一般的な手順となります。具体的なAPIの機能や詳細な設定は、開発するアプリケーションの要件によります。FastAPIの公式ドキュメンテーションやチュートリアルを参照すると、さらに詳しい情報を得ることができます。

FastAPIでRESTクライアントを作成する

FastAPIはOpenAPI仕様に基づいているため、多くのツールと自動的に互換性があります。その中には、APIドキュメント（Swagger UIによって提供される）の自動生成だけでなく、多くの異なるプログラミング言語用のAPIクライアント（またはSDK）の生成も含まれます。

以下に、FastAPIを使用してTypeScriptのフロントエンドクライアントを生成する手順を示します。

1. openapi-typescript-codegenのインストール

フロントエンドのコードでopenapi-typescript-codegenをインストールします。

npm install openapi-typescript-codegen --save-dev

2. クライアントコードの生成

クライアントコードを生成するためには、openapiというコマンドラインアプリケーションを使用します。これはローカルのプロジェクトにインストールされているため、直接そのコマンドを呼び出すことはできませんが、package.jsonファイルに記述することができます。

FastAPIアプリケーションとそのモデルがある場合、クライアントコードを生成することができます。

以上が、FastAPIを使用してRESTクライアントを作成する一般的な手順です。具体的なクライアントの機能や詳細な設定は、開発するアプリケーションの要件によります。FastAPIの公式ドキュメンテーションを参照すると、さらに詳しい情報を得ることができます。

FastAPIを使用したAPIのテスト方法

FastAPIのテストは、Starletteのおかげで簡単で楽しいものになっています。FastAPIのテストはHTTPXに基づいており、これはRequestsに基づいて設計されているため、非常に馴染みやすく直感的です。これにより、pytestを直接FastAPIと一緒に使用することができます。

以下に、FastAPIでAPIをテストするための一般的な手順を示します。

1. 必要なパッケージのインストール

まず、httpxをインストールします。

pip install httpx

2. テストクライアントの作成

FastAPIのTestClientをインポートし、FastAPIアプリケーションを渡してTestClientを作成します。

from fastapi import FastAPI
from fastapi.testclient import TestClient

app = FastAPI()

@app.get("/")
async def read_main():
    return {"msg": "Hello World"}

client = TestClient(app)

3. テスト関数の作成

test_で始まる名前の関数を作成します（これはpytestの標準的な規約です）。TestClientオブジェクトをhttpxと同じように使用します。

def test_read_main():
    response = client.get("/")
    assert response.status_code == 200
    assert response.json() == {"msg": "Hello World"}

テスト関数は通常のdefであり、async defではありません。また、クライアントへの呼び出しも通常の呼び出しであり、awaitを使用しません。これにより、pytestを直接使用することができ、複雑さがなくなります。

以上が、FastAPIでAPIをテストするための一般的な手順となります。具体的なテストの機能や詳細な設定は、開発するアプリケーションの要件によります。FastAPIの公式ドキュメンテーションを参照すると、さらに詳しい情報を得ることができます。

FastAPIを使用したAPIのデプロイ

FastAPIを使用して作成したAPIをデプロイする方法は以下の通りです。

1. デプロイの意味

デプロイとは、アプリケーションをユーザーが利用できるようにするために必要な手順を実行することを指します。Web APIの場合、通常はリモートマシンに配置し、良好なパフォーマンス、安定性などを提供するサーバープログラムを使用して、ユーザーが効率的に、中断や問題なくアプリケーションにアクセスできるようにします。

2. デプロイ戦略

具体的なユースケースや使用しているツールにより、デプロイの方法はいくつかあります。自分でサーバーをデプロイするためのツールの組み合わせを使用することもできますし、一部の作業を代行してくれるクラウドサービスを使用することもできます。

3. Dockerを使用したデプロイ

Dockerを使用してFastAPIアプリケーションをデプロイすることも一般的な方法です。Dockerを使用すると、アプリケーションとその依存関係をコンテナとしてパッケージ化し、どの環境でも同じように動作することが保証されます。

4. クラウドサービスを使用したデプロイ

Renderなどのクラウドサービスを使用してFastAPIアプリケーションをデプロイすることも可能です。これらのサービスは、アプリケーションのデプロイとスケーリングを自動化し、管理を容易にします。

以上が、FastAPIを使用してAPIをデプロイするための一般的な手順となります。具体的なデプロイの機能や詳細な設定は、開発するアプリケーションの要件によります。FastAPIの公式ドキュメンテーションを参照すると、さらに詳しい情報を得ることができます。

コメントする

メールアドレスが公開されることはありません。 ※ が付いている欄は必須項目です