【APIサーバー】データ1件を新規作成するAPIのテストを実装する

どうも、つよぽんです！

今回は「APIサーバーを実装するシリーズ」の第7回目の記事となります。

以前書いた以下の2つの記事をまだ読んでいない方は、以下の記事も読むことをオススメします。

第7回目の今回は、前回実装した「データ1件を新規作成するAPI」のテストコードを実装していきます。

今回の記事内容は、以下のリンク先で使っているスライドの一部を補足した記事になります。

実際に手を動かしながら覚えたい方は、以下のスライドも参考にすると良いでしょう。

あわせて読みたい

【テスト実装】Todo1件を新規作成するAPIのテストを実装する今回は「POST /api/todos」に対するAPIのテストを実装します。また、前回も利用したAPIテスト用のライブラリである「supertest」の共通処理をまとめたヘルパーメソッドの実装も行います。...

今回の記事は次のような方に向けて書きました。

この記事を読み終えた後のあなたは次のことがわかるようになっています。

それでは以下の内容で話を進めていきます。

requestHelperの作成(supertestの共通処理を1つにまとめる)

supertestを使った共通処理をまとめる理由

「supertest」は、以前書いた記事「【APIサーバー】データ一覧取得するAPIのテストを作成する」でインストールしたAPIテストをするために使うライブラリとなります。

今回はsupertestを直接使わずに「requestHelper」というファイルを作成して、requestHelperに実装するメソッド経由で間接的にsupertestを使うようにします。

自作メソッドを1つ挟んで間接的にsupertestを使う理由は、複数のAPIのテストで共通する部分を1箇所にまとめたいからです。

文章だけだとイメージがつきづらいと思うので、実際に今回作成するrequestHelperのコードを見ていきましょう。

requestHelperの中身

ファイルの置き場所

今回作成する「requestHelper」は、以下の画像の赤枠部分のように「test/helper/rerquestHelper.js」に作成します。(※画像をクリックすると別タブで画像が開きます)

共通部分をまとめる

以下の画像の赤枠部分は、supertestの共通部分を1箇所にまとめた様子になります。(※画像をクリックすると別タブで画像が開きます)

上の画像でまとめている共通部分は以下の3つになります。

「①Accept」「②Content-Type」に関してはMDNのドキュメントを参考にしていただけたらと思います。

また、「set」や「expect」に関しては「supertest」の提供している機能になりますので、「supertest」のドキュメントを参考にしていただけたらと思います。

動的な部分は引数経由で値を受け取る

以下の画像の赤枠部分は、動的に変わる部分を引数経由で値を渡してセットした様子になります。(※画像をクリックすると別タブで画像が開きます)

例えば、「statusCode」を例にすると、クライアントがサーバーに対して投げたリクエストが成功すれはHTTPステータスコードは200が、失敗すれば400系、500系を返ってきます。
(HTTPステータスコードに関しては以下の記事でも解説しています。)

なので、リクエストが成功するテストを実装したい場合は200をセットすることになります。

逆に、リクエストが失敗するテストを実装したい場合はクライアントエラーを期待しているのであれば400系、サーバーエラーを期待しているのであれば500系をセットすることになります。

つまり、リクエストが最終的に成功するか失敗するかに応じて、ここの「statusCode」は動的に変わるということです。

このように動的に変わる部分は固定値でセットできないので、引数経由で動的に変えられるようにする必要があります。

今回作成したrequestHelperは「GET」「POST」「PUT」「DELETE」処理も動的に切り替えられる

今回実装するテストは「POST」メソッドを使ったリクエスト処理になりますが、別記事で作成する「更新API」で使う「PUT」メソッド、「削除API」で使う「DELETE」メソッドでも使えます。

HTTPメソッドを切り替えて使いたい場合は、先ほど作成したrequestHelperの「request」メソッドの引数の「method」部分に対して「get」「post」「put」「delete」のいずれかの文字列をセットするだけで、それに対応するHTTPメソッドを利用できるようになっています。

どのような仕組みで切り替えているかはコードを見て頂ければと思いますが、わからない場合は、以下の記事先にある連絡先で「教えて欲しい」といった旨のメッセージを頂けたらと思います^^

あわせて読みたい

【絶賛受付中】プログラミング・Webの相談お気軽にどうぞ！プログラミングやWebで困っていることに対して何でも質問受け付けています。「こんなこと質問しても大丈夫かな」と思っている方のために過去にどんな質問があったのか一例で挙げているので参考にしていただけたらと思います。...

APIのテストコードの実装

APIのテストコードに関しては、1つ1つ画像を切り出して説明すると長くなってしまうので、以下のスライドの9ページ目以降を参考にしていただけたらと思います。(※スライドが見づらい場合は全画面モードで見ていただけたらと思います)

 

まとめ

今回の話をまとめると次のとおりです。

今回の内容は以下の記事内のスライドでも学習できます。

あわせて読みたい

【テスト実装】Todo1件を新規作成するAPIのテストを実装する今回は「POST /api/todos」に対するAPIのテストを実装します。また、前回も利用したAPIテスト用のライブラリである「supertest」の共通処理をまとめたヘルパーメソッドの実装も行います。...

【3つの特典付き】Webエンジニアに必要な基礎スキルを体系的に効率良く身につけたいですか？

LINE登録で無料特典を受け取る

次のような方向けに、学習をサポートするコンテンツを無料プレゼントしています。

• Webエンジニアになりたいけど何から学習を始めれば良いかわからない
• 今まで独学で頑張ってきたけど、独学に限界を感じてきた
• プログラミングは出来るけど、大きめのコードが書けない

「プレゼント詳細が知りたい」「プレゼントを受け取りたい」といった方は、以下のボタンをクリックして詳細ページをご確認ください。

無料特典を受け取る