APIテストはいつやるの？今でしょう！

<span style="font-weight: 400">皆さんこんにちは、<a href="https://www.humancrest.co.jp/">ヒューマンクレスト</a>のマイです。</span>

<span style="font-weight: 400">皆さんはAPIの開発をしていますか。テストはどうしていますか。
APIテストについて聞いたことがあるけれど、よく分からないという方は多いのではないでしょうか。 </span>

<span style="font-weight: 400">今回はそんな方のために、APIテストについてお話ししたいと思います。</span>
<h1>APIについて</h1>
<span style="font-weight: 400">私はWeb開発が大好きです。</span>
<br />

<span style="font-weight: 400">一番最初に参加したプロジェクトはLaravelというPHPフレームワークで開発していました。Laravelは素晴らしいフレームワークで、PHPでの開発では大変人気です。しかし、私にとっては、サーバーの管理が大変、チーム内での分担が難しい、そしてテストが大変という難点もありました。そして、次に出会ったのはReactでした。ちょうどサーバレスが話題になった頃なので、Reactとサーバレスというコンビで開発してみました。APIという言葉はよく耳にしていましたが、ちゃんと調べ始めたのはその時からでした。</span>

<span style="font-weight: 400">APIはApplication Programming Interfaceの頭文字です。人間とアプリケーションとの間でやり取りをするためには、ユーザインターフェース(UI)というものがあります。同様に、アプリケーションとアプリケーションとの間でやり取りするための仕組みが必要です。これがAPIです。</span>

<span style="font-weight: 400">当初は成り行きで採用していたAPIですが、開発してみて、いろいろ</span><span style="font-weight: 400">色々</span><span style="font-weight: 400">なメリットがあることが分かりました。</span>

<span style="font-weight: 400">まずはなんといっても開発プロセスの簡略化ですね。 FrontendとBackendに分けることで、開発スピードが上がりました。また、モバイルデバイスやブラウザーごと</span><span style="font-weight: 400">毎</span><span style="font-weight: 400">に開発する必要がなくなるため、開発量も削減できました。</span>

<span style="font-weight: 400">次のメリットは組み立てやすいことです。APIは独立性が高く、「部品」のように考えると分かりやすいです。その部品は新規プロジェクトはもちろん、既存プロジェクトに組み込むことが簡単です。プロジェクト間でも共通化はできます。例えば、ホームページにGoogle Map APIやFacebookのAPIが組み込まれることがよく見られるでしょう。また、デプロイすることも楽です。独立しているため、アップデートするときに、プロジェクト丸ごとをデプロイする必要がなく、必要なところだけをデプロイすれば済みます。</span>

<h1>APIテストについて</h1>
<span style="font-weight: 400">APIを導入した当初、開発プロセスを変えましたが、テストのプロセスは今まで通りに行い</span><span style="font-weight: 400">し</span><span style="font-weight: 400">ました。FrontendとBackendでそれぞれ単体テストを書いてから、結合テストを行いました。そしてシステムテストをやって、最後は受け入れテストです。ただ、ここで問題に気づきました。</span>

<span style="font-weight: 400">問題はBackend内の結合やBackendと外部システムとの結合のテストにあります。ここはどうしてもユニットテストではカバーできず、UIで行うことになっていました。UIでのテストなので、かなり実施コストがかかっています。しかし、もっと致命的なのは、テストが開始できるのが開発のかなり終盤の方になることです。ここでバグが見つかれば修正コストが非常に高いです。参考までに、Capers Jones氏が発表した以下のグラフを見れば分かりやすいでしょう。</span>

<img class="wp-image-4410 aligncenter" src="https://quesqa.com/blog/wp-content/uploads/2020/08/2018-12-10-ArthurHicken-The-Shift-Left-Approach-to-Software-Testing-image4-1.png" alt="" width="500" height="229" />
<p style="text-align: center">
<span style="font-weight: 400">(出典：</span><a href="https://www.stickyminds.com/article/shift-left-approach-software-testing"><span style="font-weight: 400">https://www.stickyminds.com/article/shift-left-approach-software-testing)</span></a></p>

<span style="font-weight: 400">もっと早めに結合テストを開始できないでしょうか。</span>

<span style="font-weight: 400">いろいろ調べたところ、APIレベルでテストすることで上記問題を回避できることが分かりました。UIの完成を待つことなく、APIが出来上がる時点でテストが可能なため、早期に結合テストを開始できるようになります。</span><span style="font-weight: 400">他にもメリットがあります。まず、UIでは実施が難しいテストケースでもAPIを直接叩くなら、実施が可能になります。例えば、入力値チェックが実装されたフォームがあるとします。異常なデータを入力すると、エラーが表示され、「送信」ボタンが非活性になります。そのとき、Backend側でも異常なデータが送信されても期待通りに処理されることを確認しないといけません。UIからテストを行う場合、入力値チェックを一時的に無効化してから、異常のデータを入力し、送信することになります。一方、 APIテストではその必要がありません。</span>

<span style="font-weight: 400">また、APIテストはUIテストと比べて、単純であり、実施時間も短いため、自動化に向いています。</span>

<span style="font-weight: 400">APIテストは単体テストの後に行うことになります。下記のテストピラミッドにあるように、しっかり単体テストを行った上で幅広いAPIテストを実施すべきです。</span>

<div align="center">
<img align="center" src="https://quesqa.com/blog/wp-content/uploads/2020/08/test-pyramid.86a621f.c307ad325f27ba6104e18eb847c76ab4-1.png" alt="" width="500" />
</div>
<p style="text-align: center"><span style="font-weight: 400">(出典：</span><a href="https://www.mostafableu.com/blog/test-automation/"><span style="font-weight: 400">https://www.mostafableu.com/blog/test-automation/</span></a>)</p>

<h1>実際にどうすれば良いのか</h1>
<span style="font-weight: 400">APIは「部品」なので、テストでは、「部品」ごとのテスト、つまり単体テスト、と「部品」と「部品」との結合テストをすれば良いでしょう。</span>

<span style="font-weight: 400">APIの「単体テスト」はいわばコンポーネントテストですね。ここでは、Requestに対して、Responseが期待通りに返却されるかを確認します。正常の場合、異常の場合、考え得るRequestに対して、サーバーがそれを処理して、正しいResponseを返却するかどうかをテスト</span><span style="font-weight: 400">検証</span><span style="font-weight: 400">します。様々なデータパターンがあるので、テストケースが多くなるでしょう。</span>

<span style="font-weight: 400">次は「部品」と「部品」との結合テスト、つまりAPIのシナリオテストです。ユーザがアプリケーションを使用する際に起きるシナリオを想定してテストを行います。例えば、オンラインショップであれば、下記のシナリオテストが想定できます。</span>

<ol>
 	<li>ログインAPI</li>
 	<li>商品リストAPI</li>
 	<li>商品詳細 API</li>
 	<li>カート追加 API</li>
 	<li>決済API</li>
</ol>

<h1>APIテストでの課題</h1>
<span style="font-weight: 400">APIテストをしようとしたとき、最初に直面するのはやはり「どうテストすれば良いか」ということです。実際にRequestを投げて、Responseを受けるところは調べればすぐ出てきますが、難しいのは「どんなテストするか」、いわゆるテスト設計のところですね。</span>

<span style="font-weight: 400">次は作業量ですね。まずテストケース作成だけでも一苦労されるでしょう。テストデータを考え、そのデータを組み合わせて、テストケースを作ることになります。次にテストケースができたら、テスト実行の環境を構築し、テストを実行します。データの組み合わせなので、テストケースが多く、テスト実行に時間がかかることが多いです。</span>

<span style="font-weight: 400">また、テストケース作成・編集など、テストケース管理が大変です。何かアップデートするとき、またテストケースを修正し、再実施するという繰り返し作業となります。</span>

<span style="font-weight: 400">メリットがあるものの、その作業量を考えて諦める人も少なくないでしょう。</span>

<h1>その問題を解決できるか</h1>
<span style="font-weight: 400">試行錯誤しながらAPIテストを行って、APIテストの大変さを痛感しました。APIテストをもっと簡単にできないかという思いで、チームと協力して、あるツールを開発し始めました。</span>

<div style="text-align: center">
<a href="https://rakapit.dockyard.biz/"><img class="aligncenter wp-image-4418 " src="https://quesqa.com/blog/wp-content/uploads/2020/08/RakAPIt_LOGO_color-4.png" alt="" width="450" height="118" /></a>
<p style="text-align: center"><a href="https://rakapit.dockyard.biz/"><span style="font-weight: 400">(https://rakapit.dockyard.biz/)</span></a></p>
</div>
<br />

<span style="font-weight: 400">RakAPItは「Raku API Testing」の略で、「楽で楽しい APIテスト 」を目指しているという意味です。では、RakAPItは上記の問題をどう解決するのでしょうか？</span>

<span style="font-weight: 400">まず、どうテストするか分からない、つまりAPIテストの敷居が高い問題です。RakAPItでは設計をサポートし、データパターンを入力するだけで、テスト ケースを自動生成する機能を搭載しました。また、API定義がSwaggerファイルで書かれている場合、なんとそのテストデータも自動生成され、さらにResponseのアサーションも自動生成されるようにしました。実行に関しても、機能が整っており、ボタンを押すだけで、テストが実行されます。</span>

<span style="font-weight: 400">次は作業量が多い問題です。 RakAPItでは、テスト設計もテスト実行も自動化されます。</span>

<span style="font-weight: 400">また、テストケース作成から、テストケース追加・修正、結果確認など、全てWebで一元管理できることでテスト管理の手間が大幅に省けます。さらに、Webサービスであるため、環境設定は一切必要とせず、ユーザ登録するだけで、すぐ始められます。</span>

<h1>まとめ</h1>
<span style="font-weight: 400">今回はAPIテストとは何か、そして APIテストの考え方についてお話ししました。</span>

<span style="font-weight: 400">次回はRakAPItを使って、APIテストは実際にどう行うかについてお話ししたいと思います。お楽しみに！</span>