【ITニュース解説】How to ace API Testing with Requestly

システム開発において、アプリケーション同士が連携するために必要な「API」（Application Programming Interface）のテストは非常に重要だ。APIが正しく動作しないと、アプリケーション全体が機能しなくなるからである。しかし、従来のAPIテストツールにはいくつかの課題があった。例えば、多くのツールは「クラウドファースト」という考え方に基づいており、APIのテストに必要な機密情報（パスワードや認証トークンなど）がクラウド上に保存されることが多かった。これにより、これらの情報が外部に漏洩するリスクがあったり、オンラインアカウントが必須だったり、テストコードとプログラムコードが別々に管理され、バージョン管理がしにくいといった問題があった。

このような課題を解決する手段として、「Requestly」というツールが注目されている。Requestlyは「ローカルファースト」というアプローチを採用しており、APIテストを開発者のPC上で直接実行できる点が大きな特徴だ。これにより、機密情報がクラウドではなく自分のPC内に安全に保管されるため、情報漏洩のリスクを大幅に減らせる。また、テストコードも開発中のプログラムコードと同じようにGitなどのバージョン管理システムで管理できるため、コードの変更履歴を追ったり、チームメンバーとの共同作業がしやすくなったりする。すべてがローカルで完結するため、素早くテスト結果を確認でき、デバッグ作業がスムーズになり、開発の負担も軽減される。

Requestlyを使ってAPIテストを始めるには、いくつかの準備が必要だ。Git、最新バージョンのNode.jsとnpm、そしてGitHubのPersonal Access Token（PAT）を用意する。Requestly自体は、ブラウザの拡張機能として、またはデスクトップアプリケーションとしてインストールできるが、本格的なテストにはデスクトップアプリの使用が推奨される。インストール後、ワークスペースという概念でテスト環境を管理する。プロジェクトのディレクトリをワークスペースとして読み込むことで、そのプロジェクトに特化したAPIテスト環境が整う。この環境内で、GitHub APIのような実際のAPIを対象にテストを作成していく。

APIテストの最も基本的な部分は、認証が正しく機能するかどうかの確認だ。Requestlyでは、APIリクエストを送信する前後にJavaScriptコードを実行できる「スクリプト」機能を使ってテストを記述する。例えば、APIが正常に認証された場合に「200 OK」というステータスコードを返すかを確認するテストは、rq.expect(rq.response.status).to.equal("OK")のように書ける。ここで使われるrq.expectは、JavaScriptのテストライブラリであるChai.jsの機能を利用しており、APIのレスポンスが期待通りのものであるかを検証（アサート）するために用いる。認証が成功した際に、ログインしたユーザーの情報がレスポンスに含まれているか、その情報が正しいかといった検証も可能だ。これは、環境変数に保存されたユーザー名とレスポンスの情報を比較することで実現できる。

APIは、サービス間の「契約」のようなものであり、レスポンスのデータの「構造」（スキーマ）が非常に重要となる。構造が変わると、そのAPIを利用している他のサービスが壊れてしまう可能性があるからだ。Requestlyでは、レスポンスボディが特定のデータ型であるか、必要なフィールドが全て含まれているか、といった詳細なスキーマバリデーションも行える。手動で一つ一つのフィールドをチェックすることも可能だが、JSONスキーマという標準的な形式で構造を定義し、rq.response.to.have.jsonSchemaというメソッドを使うことで、より簡潔に、かつ保守しやすい形でテストを記述できる。これは、複雑なAPIレスポンスの構造を一度に検証する際に非常に有効な手段となる。

さらに、Requestlyは一連のAPI呼び出しが正しく連携する「ワークフロー」全体のテストも可能にする。例えば、あるAPIで作成したデータ（IssueのIDなど）を、次のAPI呼び出し（そのIssueを取得するAPI）に利用するといったシナリオだ。Requestlyの環境変数機能を使えば、前のAPIレスポンスから得た情報を一時的に保存し、それを後のAPIリクエストで利用できる。これにより、「Issueを作成し、そのIssueを取得し、最後に削除する」といった一連の処理が正しく行われるかをテストできる。これは、ログイン後に受け取った認証トークンを他のAPI呼び出しに再利用するといった、実際のアプリケーションで頻繁に使われるパターンにも応用できる。

テストは常に成功するとは限らない。時には失敗する原因を特定する必要がある。Requestlyはデバッグ機能も提供しており、テストが失敗した場合に表示されるエラーメッセージから原因を特定する手助けをする。また、console.logを使ってAPIのリクエストヘッダーやレスポンスのステータスコードなど、様々な情報を出力できるため、開発者ツールを開いてログを確認することで、テスト失敗の根本原因を詳細に調査できる。

さらに、Requestlyの強力な機能の一つに「APIモック」がある。アプリケーションはしばしば、外部のサードパーティAPI（決済サービスや天気情報など）に依存している。しかし、これらの外部APIは開発者が自由に制御できるものではなく、テスト中に常に利用可能であるとは限らない。また、テスト呼び出しごとに料金が発生する場合もある。このような場合にAPIモックが役立つ。Requestlyはプロキシサーバーとして動作し、アプリケーションからの外部APIへのリクエストを途中で「傍受（インターセプト）」し、あらかじめ定義しておいた偽のレスポンスを返すことができる。これにより、外部APIが一時的にダウンしている状態や、特定の異常なレスポンスをシミュレーションし、自社のアプリケーションがそれらの状況を適切に処理できるかをテストできる。このモック機能は、開発者が外部APIの可用性や料金に左右されずに、様々なシナリオでテストを行うことを可能にする。

Requestlyを活用することで、単にAPIがデータを返すかを確認するだけでなく、信頼性、エッジケースへの対応、そして開発プロセスの効率化といった多岐にわたるメリットを得られる。ローカルファーストのアプローチは、機密情報の安全性を確保しつつ、重たいセットアップやクラウドアカウントの管理といった手間を省く。最初はシンプルなテストから始め、必要に応じて複雑なテストやモックを追加していくことで、デバッグや開発サイクルが大幅に改善されるだろう。