【FastAPI】APIをテストする方法【入門】

2021-12-202024-03-23

当ページのリンクには広告が含まれています。

URLをコピーしました！

敬遠しがちなテストコードですが、FastAPIではとても書きやすい印象です。

今回はテスト方法についてご紹介いたします。

パッケージのインストール

まずはFastAPI内に用いられている、テストに必要なパッケージのrequestsとpytestをインストールします。

pip install requests pytest

必要なモジュールのインポート

テスト実行用のtest_main.pyを作成します。

テストの実行には、fastapi.testclientからTestClientをインポートして記述していきます。

from fastapi.testclient import TestClient
from main import app

client = TestClient(app)

テストの実行には、pytestやpytest filenameで行います。

pytest

テストファイルの記述

今回は、複数のエンドポイントを用いてテストを試してみます。

GET /products/all 商品の全てを取得
POST /token 認証用JWTトークンの取得 (usernameとpasswordで発行)
POST /articles 新規記事を作成

APIへのアクセスとステータスコードの確認

/products/allのテストコードを記述します。

requestsのようにresponse = client.get("/products/all")でリクエストを簡単に送れます。

認証用のデータを送信する

リクエストの際にデータを送る場合は、data={}とします。

def test_auth_success():
    response = client.post(
        "/token",
        data={
            "username": "string",
            "password": "string"
        }
    )
    access_token = response.json().get("access_token")
    assert access_token

受けとったレスポンスに、アクセストークンがあるかassertでチェックしています。

assertは結果がTrueではない場合に、テスト時にエラーを返してくれます。

エラーメッセージの確認

次は同じAPIでのエラーメッセージの確認を行います。

def test_auth_error():
    response = client.post(
        "/token",
        data={
            "username": "",
            "password": ""
        }
    )
    access_token = response.json().get("access_token")
    assert access_token == None
    message = response.json().get("detail")[0].get("msg")
    assert message == "field required"

メッセージ内容を確認するだけです。

ヘッダーの付与とjson

新規記事作成のAPIをテストします。手順としては

JWTトークンの生成
ポストする内容と認証用トークンを使用してリクエストを送る
ステータスコードの確認
レスポンスで返ってきた記事の内容を確認

となります。

def test_post_article():
    auth = client.post(
        "/token",
        data={
            "username": "string",
            "password": "string"
        }
    )
    access_token = auth.json().get("access_token")
    assert access_token

    response = client.post(
        "/article/",
        json={
            "title": "string3",
            "content": "string3",
            "is_display": True,
            "creater_id": 1
        },
        headers={
            "Authorization": f'Bearer {access_token}'
        }
    )
    print(response.json())
    assert response.status_code == 200
    assert response.json().get("title") == "string3"

前半は先ほどと同じです。jsonやheadersの引数で必要な情報を送っています。

pytestの使い方についてはコチラをご確認ください。