API統合テスト完全ガイド【すぐに使えるコード付き】

API連携テストは、異なるAPIが期待通りに連携して動作することを確認するテストです。このテストでは、以下を含む様々なコンポーネントがどのように相互作用するかを検証します。

API認証
ページネーション
レート制限
レスポンスボディ

プロのヒント：シームレスなAPI連携テストには、Apidogが最適なプラットフォームです。実際のワークフローをシミュレートするプロセスを簡素化し、複数のAPIがどのように相互作用するかを効率的にテストできます。

ボタン

API連携テストの主なメリット

信頼性とデータの正確性：システム間でデータが正しく転送され、APIが信頼性高く動作することを確認します。
エラーハンドリング：エラーを特定して対処し、問題のあるAPIレスポンスに対するシステムの反応を改善するのに役立ちます。
パフォーマンス最適化：特に大量のデータを扱う際のパフォーマンスボトルネックを発見するのに役立ちます。
互換性維持：新しいAPIアップデートによってシステムが壊れないことを保証します。
セキュリティ：脆弱性を検出し、データ交換を保護するのに役立ちます。

API連携テスト vs. 単体テスト

単体テスト：個々のコンポーネントや関数を単独でテストします。
連携テスト：異なるコンポーネント（APIを含む）がどのように連携して動作するかをテストします。APIの連携全体が機能することを確認します。

API連携テストの主要なステップ

テスト計画の策定：テストの目標とシナリオを概説します。
テストケースの作成：様々なユースケースをカバーする異なるテストケースを作成します。
テストの実行：連携テストを実行します。
問題の追跡、報告、解決：テストから問題を特定し、解決し、進捗を追跡します。
再テスト：修正が新しい問題を引き起こすことなく問題を解決していることを確認します。
繰り返し：バグがなくなるまで連携を継続的に改善します。

Apidogを使ったAPI連携テスト

Apidogは、QAエンジニアが複数のAPIを含む実際のワークフローをシミュレートする複雑なテストシナリオを設計・実行できるようにすることで、API連携テストを大幅に効率化します。

例えば、ペット購入プロセスのように、ペットリストの閲覧、カートへの追加、注文、支払い、注文詳細の照会など、様々なAPIが相互作用するシナリオにおいて、Apidogはこれらの相互接続されたテストを簡単に設定できます。

QAエンジニアは、APIエンドポイントをリンクさせ、それらの間でデータを転送することでシナリオを作成できます。例えば、「注文作成」とそれに続く支払いおよび注文照会エンドポイント間で注文IDを渡すといったことが可能です。Apidogの堅牢なデータ処理機能により、注文IDを変数として保存するか、前のステップからの戻り値を直接参照することで、これを実現し、テストプロセスを効率化します。

カートに複数のペットを追加するような一括操作など、より複雑な操作の場合、ApidogのForEachループは、配列からペットIDを各APIリクエストに自動的に挿入することでタスクを簡素化します。

テストシナリオが作成・実行されると、Apidogは詳細なテストレポートを生成します。これにより、QAエンジニアは問題を迅速に特定して修正し、すべてのAPIが統合されたワークフロー内で正しく機能することを確認できます。

Apidogの連携テスト機能により、開発者は実際のユーザーアクションを効率的にシミュレートし、複数のエンドポイントをまとめてテストし、API間でのシームレスなデータ交換を保証できます。これにより、ApidogはAPI開発、テスト、連携のための最適なプラットフォームとなっています。

ApidogがAPIテストをどのように強化し、QAエンジニアのテスト効率を向上させるかをご覧ください。

API連携テストのベストプラクティス

モックライブラリの使用：requests_mockのようなライブラリを使用してネットワークインタラクションをシミュレートします。これにより、テストが分離され、実際のAPI呼び出しを回避することでテストが高速化されます。
エラーハンドリング：様々なAPIエラー（例：404、500）に対してシステムがどのように応答するかをテストし、システムが壊れないことを確認します。
境界値テスト：極端な値を使用して、システムがそれらをどのように処理するかをテストします。
後方互換性：APIの変更が既存の機能を壊さないことを確認します。
現実的なデータ：現実的なシナリオ（例：実際のユーザーデータ、正確な価格設定）を使用して、システムが現実世界でどのように動作するかをテストします。
テストの更新：APIが進化するにつれて、テストを更新して正確性と信頼性を維持します。

API連携テストの例

ここでは、Pythonとrequests_mockライブラリを使用したAPI連携テストの実践的な例を示します。

ステップ1：必要なライブラリのインストール

pip install requests requests_mock

ステップ2：API連携コードの例

この例では、2つの公開APIを連携させる方法を示します。1つは通貨換算用、もう1つは郵便番号に基づいて製品の在庫を確認する用です。

import requests

def get_converted_price(product_price: int, conversion_currency: str) -> float:
    converted_price = None
    base_currency = "usd"
    api_url = f"https://cdn.jsdelivr.net/gh/fawazahmed0/currency-api@1/latest/currencies/{base_currency}/{conversion_currency.lower()}.json"

    try:
        resp = requests.get(api_url)
        if resp.ok:
            currency_data = resp.json()
            converted_price = product_price * currency_data[conversion_currency]
            print(f"Converted price: {round(converted_price, 2)} {conversion_currency.upper()}")
        else:
            print(f"Error: {resp.text}")
    except Exception as ex:
        print(f"Exception: {ex}")
    finally:
        return converted_price

def get_product_availability(zipcode: int) -> bool:
    availability = None
    api_url = f"https://api.zippopotam.us/us/{zipcode}"

    try:
        resp = requests.get(api_url)
        if resp.ok:
            zip_data = resp.json()
            state = zip_data["places"][0]["state"]
            availability = False if state in ["Texas", "California"] else True
            print(f"Availability in {state}: {availability}")
        else:
            print(f"Error: {resp.text}")
    except Exception as ex:
        print(f"Exception: {ex}")
    finally:
        return availability

ステップ3：API連携のテスト

unittestとrequests_mockを使用して、連携を検証するための単体テストを作成できます。

import unittest
import requests_mock
from api_integration import get_converted_price, get_product_availability

class TestAPIIntegrations(unittest.TestCase):

    def test_get_converted_price(self):
        test_data = {"usd": 82.6}
        expected_price = 8260
        with requests_mock.Mocker() as mock:
            mock.get("https://cdn.jsdelivr.net/gh/fawazahmed0/currency-api@1/latest/currencies/usd/inr.json", json=test_data)
            calculated_price = get_converted_price(100, "inr")
            self.assertEqual(calculated_price, expected_price)

    def test_get_converted_price_failure(self):
        with requests_mock.Mocker() as mock:
            mock.get("https://cdn.jsdelivr.net/gh/fawazahmed0/currency-api@1/latest/currencies/usd/inr.json", status_code=404)
            calculated_price = get_converted_price(100, "inr")
            self.assertIsNone(calculated_price)

    def test_get_product_availability_true(self):
        test_data = {"places": [{"state": "California"}]}
        with requests_mock.Mocker() as mock:
            mock.get("https://api.zippopotam.us/us/90210", json=test_data)
            availability = get_product_availability(90210)
            self.assertTrue(availability)

    def test_get_product_availability_false(self):
        test_data = {"places": [{"state": "Texas"}]}
        with requests_mock.Mocker() as mock:
            mock.get("https://api.zippopotam.us/us/75001", json=test_data)
            availability = get_product_availability(75001)
            self.assertFalse(availability)

    def test_get_product_availability_failure(self):
        with requests_mock.Mocker() as mock:
            mock.get("https://api.zippopotam.us/us/75001", status_code=500)
            availability = get_product_availability(75001)
            self.assertIsNone(availability)

if __name__ == '__main__':
    unittest.main(verbosity=2)

ステップ4：API連携テストの実行

テストを実行するには、ターミナルで以下のコマンドを使用します。

python api_integration_tests.py

これにより、すべてのテストが実行され、モックAPIレスポンスが正しく処理されたか、期待される結果が得られたかなど、各テストの詳細な出力が表示されます。

まとめ

API連携テストは、APIが意図した通りに連携して機能していることを保証します。モックライブラリと包括的なテストケースを使用することで、システムの連携動作を効率的に検証できます。APIが進化するにつれてテストを常に更新し、継続的インテグレーションのために自動テストの実装を検討してください。

連携プロセスをさらに自動化したい場合は、Apidogのようなツールが、連携を迅速に拡張およびテストするための統合APIを提供しています。