JavaScript

【APIサーバー】データ1件を新規作成するAPIを追加【Controller実装】

どうも、つよぽんです!

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

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

第6回目の今回は、前回Model(Todoモデル)に実装した「データ1件を新規する機能」を利用して、以前作成したControllerとRouterにAPIの追記実装をします。

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

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

あわせて読みたい
【Controller実装】Todo1件を新規作成するAPIを実装する今回はTodo1件を新規作成するAPIを実装します。新規作成を行う場合は、一般的にHTTPメソッドのPOSTを使います。また、GET以外のHTTPメソッドを使った処理の挙動を確認するために「Postman」というツールを導入しました。Postmanを使うことでAPIサーバーのデバッグが楽になります。...

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

想定読者
  1. ルーティング設定と実処理を分離した書き方を知りたい方
  2. GETメソッド以外のAPIの動作の確認方法を知りたい

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

この記事を読み終えた後のあなた
  • ルーティング(Router)と実処理(Controller)を分離して、紐付ける実装方法がわかる
  • GETメソッド以外のAPIの動作の確認方法がわかる

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

今回の内容
  1. body-parserのインストールと設定
  2. ルーティング用のファイルと実処理用のファイルを分けて、紐付ける
  3. Postmanを使って、GETメソッド以外のAPIの動作を確認する

body-parserのインストールと設定

body-parser」は、クライアントから送信されたデータをexpress内で扱いやすくするためのライブラリです。

具体的には「body-parser」を使うことで、express内で「req.body」で送信データを受け取れるようになります。

body-parserのGitHubレポジトリに書かれている説明文body-parserのGitHubレポジトリに書かれている説明文

body-parserをインストールする

以下の画像のように「npm install body-parser」でbody-parserをインストールします。(※画像をクリックすると別タブで画像が開きます)

body-parserをインストールbody-parserをインストール

body-parserの設定をapp.jsに追加

以下の画像は、app.jsにbody-parserの設定を追加した様子になります。(※画像をクリックすると別タブで画像が開きます)

app.jsにbody-parserの設定を追加app.jsにbody-parserの設定を追加

画像左側が修正前のコードで、画像右側がbody-parserの設定を追加したコードになります。

今回は、画像右側の赤枠内の3行のコードを追加すればbody-parserの設定は完了です。

この設定により、クライアントからJSON形式で送られてきたデータを、express内で「req.body」で受け取れるようになりました。

ルーティング用のファイルと実処理用のファイルを分けて、紐付ける

controllers/todos.jsにpostTodoメソッドを追加する

以下の画像のように、「controllers/todos.js」にpostTodoメソッドを追加します。(※画像をクリックすると別タブで画像が開きます)

controller/todos.jsにpostTodoメソッドを追加controller/todos.jsにpostTodoメソッドを追加

postTodoメソッドは、クライアントからHTTPメソッドのうち、POSTメソッドを使ってリクエストがあった時の処理を行います。

postTodoメソッドの中身は後ほど実装するので現時点ではこれで問題ありません。

routers/todos.jsにPOSTメソッドの処理を追加する

以下の画像の赤枠内では、RouterにPOSTメソッド用のルーティングを追加して、先ほど用意したpostTodoメソッドと紐付けています。(※画像をクリックすると別タブで画像が開きます)

RouterにPOSTメソッドの処理を追加RouterにPOSTメソッドの処理を追加

左側の赤枠内で「post(controller.postTodo)」を追加しました。

以前書いた記事「【APIサーバー】データ一覧取得するAPIを追加【Controller実装】」で追加したコード「get(controller.getTodos)」(postの1行前のコード)とやっていることはほとんど同じで、それぞれの内容をまとめると次のとおりになります。

  • get(controller.getTodos)
    • クライアントからGETメソッドでリクエストがあったら「controller.getTodos」メソッドを実行する
  • post(controller.postTodo)
    • クライアントからPOSTメソッドでリクエストがあったら「controller.postTodo」メソッドを実行する

上記2つの違いは太い赤字で書いた部分だけです。

postTodoメソッドの実処理を実装する

postTodoメソッドの中身については、以下の画像を参考にしていただけたらと思います。(※それぞれの画像をクリックすると別タブで画像が開きます)

postTodoメソッドの全体像

今回実装するpostTodoメソッドの全体像今回実装するpostTodoメソッドの全体像

req.body経由でクライアントからの送信データを受け取る

req.bodyでクライアントからの送信データを受け取れるのは、先ほどインストールして設定した「body-parser」のおかげです。

req.bodyでクライアントからの送信データを受け取るreq.bodyでクライアントからの送信データを受け取る

データを1件新規作成する

「Todo.create」は前回記事「【APIサーバー】データ1件を新規作成する機能の実装【Model実装】」で作成しました。

クライアントから受け取ったデータを元にTodoデータを新規作成するクライアントから受け取ったデータを元にTodoデータを新規作成する

データ作成が成功したら、クライアントに作成したデータを返す

データの新規作成に成功したら、クライアントに作成したデータを返すデータの新規作成に成功したら、クライアントに作成したデータを返す

データ作成に失敗したら、エラー情報をクライアントに返す

データ作成に失敗したら、エラー情報をクライアントに返すデータ作成に失敗したら、エラー情報をクライアントに返す

Postmanを使って、GETメソッド以外のAPIの動作を確認する

WebブラウザのURL入力欄を使った動作確認はGETメソッドしかできない

以前、「【APIサーバー】データ一覧取得するAPIを追加【Controller実装】」で実装したAPIに関してはGETメソッドのAPIでした。

つまり、Webブラウザを使ってURL入力欄にAPIのURLを入力して実行すれば、実行結果を受け取ることが出来ました。

逆に言うと、GETメソッド以外のAPIはWebブラウザのURL入力欄にAPIのURLを入力しても実行することは出来ません。

今回は「POST」メソッドを使います。また、今回の「APIサーバー実装シリーズ」の後半では「PUT」「DELETE」メソッドも利用します。

それでは「POST」「PUT」「DELETE」メソッドを使うAPIの動作確認はどうすれば良いでしょうか?

方法はいくつかありますが、今回は「Postman」というツールを使った方法でAPIを実行していきます。

Postmanとは

PostmanのトップページPostmanのトップページ

Postman」とは、一言で言うと「好きな条件で特定のサーバーにリクエストを投げることができるツール」になります。

今回の場合は以下のような条件でAPIサーバーにリクエストを投げたいです。

  • POSTメソッドでリクエストを投げたい
  • APIサーバーにリクエストを投げるときにJSON形式のデータを送信する

上記2つの条件をPostmanを使うことで簡単に満たすことができます。

それでは、実際にPostmanを使って先ほど実装したAPIの動作を確認してみましょう。

Postmanを使って、さきほど実装したAPIを実行する

Postmanを使った動作確認方法は、以下の画像を参考にしていただけたらと思います。(※それぞれの画像をクリックすると別タブで画像が開きます)

POSTメソッドを選択する

POSTメソッドを選択POSTメソッドを選択

APIのURLを入力する

APIのURLを入力するAPIのURLを入力する

APIサーバーに送信するデータをセットするための設定を選択

サーバーにデータを送信するための設定をするサーバーにデータを送信するための設定をする

送信するデータを入力する

送信するデータの入力送信するデータの入力

サーバーにリクエストを投げる

サーバーにリクエストを投げるサーバーにリクエストを投げる

サーバーからレスポンス値が返ってくる

サーバーからのレスポンス値が返ってくるサーバーからのレスポンス値が返ってくる

エラー時の挙動を確認した様子

エラー時の挙動を確認した様子エラー時の挙動を確認した様子

まとめ

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

今回のまとめ
  • クライアントからの送信データを扱いやすくするためのライブラリ「body-parser」をインストールした
  • 「body-parser」の設定をした
  • RouterとControllerにデータ新規作成用の処理を追加実装した
  • Postmanを使って実装したAPIの動作を確認した

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

あわせて読みたい
【Controller実装】Todo1件を新規作成するAPIを実装する今回はTodo1件を新規作成するAPIを実装します。新規作成を行う場合は、一般的にHTTPメソッドのPOSTを使います。また、GET以外のHTTPメソッドを使った処理の挙動を確認するために「Postman」というツールを導入しました。Postmanを使うことでAPIサーバーのデバッグが楽になります。...
【やる気満々な方向け】学習サポートとオンライン講義やってます!

「とにかく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. 不定期で行うオフラインでの勉強会に参加(僕自身が東京住みのため、東京・もしくは東京近郊で開催します)

プランの学習コンテンツ・課題を全て終えたあと、何が身につくか

全ての学習コンテンツと課題を終えて、さらに最終課題を終えた後のオススメの学習と追加課題までクリアした際には、あなたは次にような状態になっています。

プランを終えた後のあなた
  1. Webのフロントエンドとバックエンドの基本を身につけて、自分で作りたいWebサービスを1人で作れるようになる
  2. 最終課題と、最終課題後にオススメしている追加課題をクリアした際には、それをそのままポートフォリオとして使えるまえ、そのまま就職活動・転職活動に活用できる
  3. 学習コンテンツと課題を進めるほどに難易度があがってくるため、必然的にドキュメントを読む必要も出てきて、自己解決力が自然と身につく
  4. 最終課題では「Git Flow」の手法で開発を進めるため、自然とチーム開発の基本スキルを身につけることができる
  5. テストコードを書くスキルが身につく(開発の現場ではアプリの動作を保証するためにテストを書くことが重要で、就職活動・転職活動のときにテストが書けることがアピールできるとかなり良い印象を持たれる
  6. 課題のコードレビューでは「GitHub」の「プルリクエスト」を使ってレビューを行っており、これはチーム開発の現場でも同じ方法でのレビュースタイルになるため、開発の現場に入ったとしてもすぐにコードレビューの制度に馴染める
  7. 課題をこなして、コードレビューの依頼を繰り返すことで、自然と開発に必要な最低限の「Git」「GitHub」のスキルを身につけることができる

プラン受講者のレビュー

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

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

『【やる気満々な方向け】未経験からのWebエンジニア育成コース』にて、HTMLの基礎から始めていったんJavaScriptバックエンドの学習を終えましたのでレビューさせていただきます^^

学習コンテンツが充実していて、しかも最新のJavaScriptにマッチしているのでとても勉強になります。

また質問に対するレスポンスも早く、かつ丁寧に詳しく教えていただけるので、疑問に思ったところはもれなく解決できました。

今はJSのライブラリであるReact.jsをUdemyにて学習中ですが、つよぽんさんのところで勉強を一通り教えていただいていたおかげですんなり理解できてかなり助かっています。

ちなみにつよぽんさんも現在React.jsの教材をアップ中なので、しばらくしたらReact.jsの勉強もつよぽんさんの学習コンテンツ一本で学べるようになると思います^^

学習サイトがわかりやすく、実際にコードを書いて学べるのでスキルアップに繋がりました!
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回、カフェでスイーツ・ドリンクセットを注文するくらいの値段(約700円)」で以下の環境が手に入るとイメージして頂けたらと思います。

  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人へのサポートの質を維持するのが難しくなるので、値上げする可能性もあります。

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

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

また、僕1人がコードレビューや質問への対応を行っているため、物理的に対応が厳しくなった場合はその時点で募集を打ち切ります。

つまり人数制限があります。

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

プランに興味がある」「もう少し詳しく内容を知りたい」「私にこのプランは向いているか聞きたい」といった方は、人数制限で募集を打ち切る前に、以下のいずれかでメッセージをいただけたらと思います^^

 

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

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

COMMENT

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