JavaScript

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

どうも、つよぽんです!

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

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

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

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

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

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

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

想定読者
  1. APIサーバーの実装の流れを理解したい方
  2. APIのテストを実装する方法を知りたい方

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

この記事を読み終えた後のあなた
  • APIのテストが実装できるようになる

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

今回の内容
  1. requestHelperの作成(supertestの共通処理を1つにまとめる)
  2. APIのテストコードの実装

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

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

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

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

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

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

requestHelperの中身

ファイルの置き場所

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

helperディレクトリを作成して、その中にrequestHelper.jsを作成するhelperディレクトリを作成して、その中にrequestHelper.jsを作成する

共通部分をまとめる

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

supertestの共通処理を1つにまとめるsupertestの共通処理を1つにまとめる

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

  1. set(‘Accept’, ‘application/json’)
  2. expect(‘Content-Type’, /application\/json/)
  3. expect(statusCode)

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

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

GitHub上のドキュメント : 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の相談お気軽にどうぞ!プログラミングやWebで困っていることに対して何でも質問受け付けています。「こんなこと質問しても大丈夫かな」と思っている方のために過去にどんな質問があったのか一例で挙げているので参考にしていただけたらと思います。...

APIのテストコードの実装

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

 

まとめ

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

今回のまとめ
  • requestHelperの解説
  • requestHelperを使った、新規作成APIのテストコードの実装

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

あわせて読みたい
【テスト実装】Todo1件を新規作成するAPIのテストを実装する今回は「POST /api/todos」に対するAPIのテストを実装します。また、前回も利用したAPIテスト用のライブラリである「supertest」の共通処理をまとめたヘルパーメソッドの実装も行います。...
【やる気満々な方向け】学習サポートとオンライン講義やってます!

Webエンジニアになりたい人向けに、MENTA にて『【やる気満々な方向け】未経験からのWebエンジニア育成コース』というプランを用意しております。

このプランでは、主に「【学習コンテンツ】Web開発」を使って学習を進めていただきます。

あわせて読みたい
Web開発Webエンジニアになるために必要な知識・スキルを学習できるコンテンツを用意しました。未経験者でも、①開発環境の準備、②Webの基本的な仕組み、③HTML、④CSS、⑤JavaScriptと順を追って学習することでスキルが身につくことを目的に教材を作成しています。...

誰向けのプラン?

こちらのプランは次のような方に向けて作られています。

プラン対象者
  1. Progateやドットインストールで一通り学習したけど、次に何をすればよいかわからない
  2. Webエンジニアになるまでの学習プランがあると助かる
  3. 学習していてわからないところが出てきたときに質問したい
  4. コードレビューして欲しい
  5. オンライン講義に参加したい
  6. 学習した内容をアウトプットした際に、フィードバックがもらえたら嬉しい
  7. おすすめの学習教材を知りたい
  8. Webフロントエンド・バックエンドを学習したい
  9. フルスタックエンジニアになりたい
  10. 文系出身で今までプログラミングをしてこなかったけど、将来Webエンジニアになりたい
  11. 将来フリーランスになることを目指している

プラン内容は?

【やる気満々な方向け】未経験からのWebエンジニア育成コース』では次のことを行っております。

プラン内容
  1. Web白熱教室の学習コンテンツをメインに、指定した教材を使って学習する (学習プランに沿って学習を進めていただきます。)
  2. 学習コンテンツの課題をこなしたあとは、僕にコードレビュー依頼を投げていただくことで、コードを添削する(課題クリア後は、引き続き学習プランの内容を続けていただきます。)
  3. プラン契約者が参加するSlackグループにて質問し放題
  4. Slack内にある「アウトプットの場」チャンネルにて、学習したことをアウトプットをしていただくことで、それに対しフィードバックをする (学習内容のアウトプットは復習にもなるため、アウトプットすることを強く推奨します。)
  5. 画面共有を使ったオンライン講義 (オンライン講義は録画して、いつでもふり返れるようにしています。(オンライン講義動画(ウェビナー動画)))
  6. 学習プラン以外の内容に対しての質疑応答 (内容によっては回答できないものもありますが、まずは気軽に質問していただけたらと思います。)
  7. 不定期で行うオフラインでの勉強会に参加(僕自身が東京住みのため、東京・もしくは東京近郊で開催します)

プラン受講者のレビュー

ありがたいことに、このプランを受講していただいているメンティーさんから高評価嬉しいレビューをいただけております。

以下のコメントは、これまで頂いたレビューコメントになります。(以下のレビューは一部で、全てのレビューはこちらのページからご確認いただけます。)

学習サイトがわかりやすく、実際にコードを書いて学べるのでスキルアップに繋がりました!
IT未経験ですが、ITサポート事務の仕事が決まり、簡単なプログラミングは任せて貰えるようになりました!
ありがとうございました^^*

お世話になって1ヶ月ほど経ちますが、コードレビューや質問対応などがとても丁寧で、とても助かっています。
また独自コンテンツやエクササイズなどもわかりやすく、勉強を進めやすいです。

初心者の私にでもとても丁寧に粘り強く
教えて頂けました。テキストや動画など見ながら
進めれましたし、質問にもすぐに回答いただけました。
ありがとうございました!

レスポンが早く、適切でとても助かりました。オリジナルコンテンツも充実しており、自分で調べてどうしても分からないところはメンターさんが教えてくださるので、プログラミング初心者の方には特におすすめです。

まだ始めたばかりですが、レビューや質問対応がとても早く丁寧でありがたいです。
ロードマップも用意されているので独学ではわからなかった学習手順がはっきりし、どのように勉強すればいいかが理解できました。

学習方法について、親身に相談に乗っていただき感謝しております。
現役エンジニアの立場から的確なアドバイスをいただき大変参考になりました。

まだメンターになって頂いてまだ間もないですが、とても感謝してます。この値段で申し訳なくなるレベルです。
・対応が丁寧。
→コードレビューでは細かい所まで指摘してくれる
→質問に対しては詳細な説明やレファレンスをつけて返信してくれる
・レスポンスが早い。
→遅くなるとしても前もって連絡してくれる
・学習の進め方や教材などもサポートしてくれる
・質問でなくても、学習状況などを報告するとフィードバックを返してくれる

その他、ペアプロや週一のオンライン会議での講義などもあり、かなりサポートも手厚いです。
特に、勉強したいけど何から始めればいいか分からないという方にオススメです。

未経験からWebエンジニアに内定・案件獲得した受講者のアウトプット

このプランで提供している学習コンテンツの最終課題をクリアしたメンティーさんに対して、ReactVueの学習をオススメしており、React・Vueのコードレビューも行っております。

以下のコメントは、最終課題をクリアしたあとにVueを学習して、「未経験からWebのフロントエンジニアの内定獲得」「未経験から案件獲得」を達成したメンティーさんのアウトプットです。

【進捗報告】
つよぽんさんにメンターになっていただき、この度Webエンジニア(フロント)として未経験から内定をいただく事ができました!
つよぽんさんから聞かれた事を中心に情報を共有したいと思います。

フロントエンド、バックエンドのスキルセット
-フロントエンド
HTML/CSS、JavaScript、Vue.js、Vuex、axios、Jest
-バックエンド
Node.js、express、MySQL、Sequelize、Mocha

面接時に見せたポートフォリオ
Vue.jsを使った簡単な自己紹介ページ、Web白熱教室のバックエンド最終課題にVue.jsを使って実装したフロントを連携し作成したTodoアプリ、この2つをポートフォリオとして転職活動をしました。Todoアプリは上のスキルセットにある技術を使用して作成しました。

面接時に良い印象を持っていただいた内容
・フロントとバックエンドの両方を学習している事
これは技術的な質問でWebの仕組みについての質問が結構あったので、両方学習してお
いて良かったなと感じました。
・技術に興味があると感じてもらえた事
最後の質問でなるべく自分の興味がある技術や自分がやってみたい事を伝えてアドバイ
スをもらったり、質問すると良い印象を持ってもらえました。

転職活動で感じた事
今回の転職活動で、ポートフォリオがいかに大事かというのを身を持って実感しました。ポートフォリオがないとそもそも面接しないという所が多かった印象です。ポートフォリオのレベルは高い方が良いとは思うのですが、しっかりアウトプットできている事が大事だと感じました。自分のポートフォリオもレベルは低かったので。

簡単にですが、まとめさせていただきました!
面接での質問内容など気になった事があれば、共有できればと思っているので、なんでも気軽にお聞きください。

進捗報告というか、現在どんなことやっているか報告しておきます!!


Vue+Laravelの案件を獲得することができました!!
元々副業ができるようになるを目標にしていたので、とりあえず目標達成です。
Laravelは完全独学で、ここでjsの基礎を学習した後にPHPの基礎から学習しました。
ですので、未経験から学習を初めて2~3ヵ月くらいで案件獲得までこぎつけることができたので、皆様の励みになればと思います。


会社で簡単なWebアプリを作って提案しました。自社装置のレイアウトを提案してくれるアプリです。expressとVueを使ってます。

もちろんVueを選択するメンティーさんだけなく、Reactを選択するメンティーさんもいらっしゃいます。

Reactを選択したメンティーさんの現在の状況としては以下のとおりです。

  • 新卒でWebエンジニアとして働き、1年目から希望する部署で働けている
  • プログラミングの基礎力、自己解決力・自走力を身につけ、FlutterやTypeScriptの学習も独学で進められている

 

1日1回カフェでコーヒー1杯頼むくらいの金額で参加できます

1日1回、カフェでコーヒー1杯分くらいの値段(約330円)」で以下の環境が手に入るとイメージして頂けたらと思います。

  1. コードを添削してもらえる
  2. 学習したことのアウトプットに対してフィードバックしてもらえる
  3. いつでも質問出来る
  4. 週1のオンライン講義に参加できる
  5. 過去のオンライン講義動画を好きな時間に復習できる(いつでも閲覧可能)
  6. 不定期で行うオフラインでの勉強会に参加できる(僕自身が東京住みのため、東京・もしくは東京近郊で開催します)
  7. 自分の住まいの近場のメンティーさん同士で集まって、オフラインで勉強会を開くのも可能(初めて開催する場合は事前に僕に連絡をいただけたらと思います)

学習教材には、このサイトで用意している「【学習コンテンツ】Web開発」を使います。

【学習コンテンツ】Web開発」を使って学習を進めることで、Webのフロントエンドとバックエンドのスキルを身につけていくことができます。

プログラミングスクールとの比較

プログラミングスクールに通う場合は1ヶ月で10万円以上するところも多いですし、3ヶ月で50万円、更には100万円するところもあります。

プログラミングスクールの値段が高い理由は、「プログラミングスクールで働いている人の人件費」「就職のサポート」なども含まれているからです。

10万円50万円100万円」のいずれの場合も、自己投資とはいえ、支払うのにはだいぶ勇気がいる金額かと思います。

オススメの学習方法

個人的にオススメするのは、プログラミングのできるメンター(師匠)を見つけて、まずは1ヶ月プログラミング学習をしてみて、自分にプログラミングが向いているかどうか確かめてみることです。

10万円50万円100万円」を払って、学習していく中で「やっぱり自分にはプログラミングは向いてない」と判断した場合、その金額はかなりの痛手となります。

そのため、まずは「これくらいの金額なら最悪失っても痛くないな」の値段で教えてくれるメンターを見つけて、そのメンターに色々と質問をしてみましょう。

それで、「良さそうだな」と思ったら教えてもらうといった流れで学習を始めると、金額もだいぶ節約できます。

注意点

ただし、参加者が増えてきたら、1人1人へのサポートの質を維持するのが難しくなるので、値上げする可能性もあります。

値上げする理由は次の以下の理由となります。

  • 値段を上げて参加ハードルをあげることで、自己解決スキルも身につけたいと考えている学習意欲の高い人だけが参加するようになる
    • 調べたらすぐにわかることを、自分で調べずに何でもかんでも質問すると、自己解決スキルも身につかない
    • 更に、他のメンティーさんの対応する時間が取れなくなりサポートの質の低下にも繋がる

詳しく話を聞いてみたい方は

以下のいずれかでメッセージをいただけたらと思います^^

 

プラン内容については以下のリンク先からも確認することが出来ます^^

【やる気満々な方向け】未経験からのWebエンジニア育成コース

COMMENT

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です