はじめに
bravesoft 株式会社でサーバサイドエンジニアをしているみっちーです。
今まで開発を続けている中で、APIレベルでの自動テストを行いたいという気持ちはありつつもなかなかできていなかったのですが、API開発ツールとして使っている Apidog にその機能があったので、実際に使ってみることにしました。
そもそも Apidog を使うようになったきっかけ
私の開発チームでは、もともとバックエンド担当者が Swagger で API のドキュメントを作り、HTML出力したあとでフロントエンド担当者へ渡すという運用を取っていました。
APIドキュメントの修正が発生した場合に都度ビルドしないといけないなど手間に感じていたなかふと Apidog を知り、ドキュメントを書いてリアルタイムに共有しつつ、そのまま実行もできるということで試しに使ってみることにしました。
また、書いたドキュメントを元にそのままテスト実行ができるのも大きなメリットに感じました。
Apidog 自体についてや他のツールと比べたメリットについては、すでに書かれた記事がいくつかあるので、ここでは割愛します。
テスト対象
現在開発が大詰めに入っている弊社の新規プロダクトである「イベスタ」の API でやっていきたいと思います。
イベントサイト制作やチケット販売を今すぐ無料でカンタンに始められ、オフ会イベントや音楽ライブ、ビジネスセミナー、大学生のタコパまで、誰でも気軽に開催できるイベントスタートサービスとなっています。
自動テストの作成方法
API のパスやパラメータなどはダミーで、実際のものとは異なります。
Apidog の左側のメニューある「自動テスト」を選択し、「テストシナリオを新規作成」ます。
テストシナリオの名称をつけます。
今回はイベスタでイベントを作成してコンテンツなどを追加して、削除するまでの一連の流れをテストしてみたいと思います。
ステップを追加から、実行したい API を設定します。
ここではすでに定義済みの API を選びましたが、開発時にテスト実行用として用意した APICase の参照、また新たにリクエストを定義したり cURL をインポートしたりすることもできます。
Apidog で管理していない API を実行する際は、cURL からインポートすると便利かと思われます。
自動テストを実施するうえで動的値を扱うことは必須かと思いますが、 Apidog ではそれを視覚的かつ簡単に設定することができました。
下記赤枠のボタンをクリックすると色々と選択肢が出てくるので、「前置きステップの結果を読み込み」をクリックします。
自身の API よりも前に実行した API の一覧が選択できるのでその中から対象の API を選び、JSONPath 式で参照したい値を指定します。
この時赤枠のボタンをクリックすると、定義済みのレスポンスから例を自動生成してくれます。
ここで表示される値は適当ですが、「JSONパスを抽出」ボタンをクリックすることで、対象データまでのパスを取得することができます。
パラメータは {{$.1.response.body.data.event_id}} と出力されました。
{{$.[APIの実行順番号].response.body.[目的の値までのパス]}} という形式のようです。
上記はパスパラメータの例ですが、body の中にも同様に設定することができます。
最終的に下記のようなシナリオとなりました。
自動テストの実行
テストの実行は右上の「実行」ボタンから行うことができます。
実行結果はこのように表示されます。
レポートをエクスポートすることもできました。
HTMLファイルがダウンロードされ、開くと下記のようなページでまとまっていました。
「API Request状況」には、実行した API が一つずつ列挙されています。
失敗させてみる
テストが失敗した場合の動きも見てみます。
ここでは、イベント主催者の電話番号を tel というキーで返すはずが、なぜか telephone にしてしまったケースを想定します。
実行したところ、該当データ取得の API 1件でエラーになりました。
該当業をクリックすると詳細を見ることができ、tel のキーが存在しないというエラーだと表示されました。
ここで注目したいのが、レスポンスのステータスコードとしては 200 であるかつ、テストの期待値を明示的に書いていないのにエラーを検知した点です。
Apidog 側で正しくレスポンスの定義をしていれば、たとえ 200 が返ってきた場合であっても定義と反するレスポンスだった場合に、不正な状態を検知することができます。
この点は大きなメリットかなと感じました。
まとめ
今回は Apidog の自動テストについて実際に使いつつ調査してみました。
テストシナリオの作成にはそれほど手間取らず、APIドキュメントを作った延長線上で自動テストができるということはやはり大きなメリットに感じました。
また実際に試せてはいないものの、Github Actions などの CI/CD とも連携できるようなので、更に便利に使うことができそうです。
Apidog 自体まだベータ版や近日公開の機能もあるので、動向を追いつつも引き続き積極的に使っていきたいと思います。