JavaScript

【APIサーバー】データ一覧取得するAPIを追加【Controller実装】

どうも、つよぽんです!

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

前回記事「【APIサーバー】データ一覧取得する機能の追加【Model実装】」をまだ読んでいなくて、APIサーバーの実装経験が無い方は前回記事を読んでおくことをおすすめします。

第3回目の今回は、前回Model(Todoモデル)に実装した「データ一覧を取得する機能」を利用して、ControllerとRouterを追加していきます。

Routerの使い方に関しては、以前書いた記事「【express】2ページ分のルーティング処理を実装する【express.Router】」でも解説しています。

Routerの使い方を詳しく知りたい方はそちらも参考にしていただけたらと思います。

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

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

あわせて読みたい
【Controller実装】Todo一覧を取得するAPIを実装する今回はAPIサーバーのControllerを作成して、Todo一覧を取得するAPIを実装します。また、作成したControllerとRouterを紐づけてルーティングの設定も行います。最後に、実装したAPIの挙動を確認するためにWebブラウザにアクセスして、Todo一覧が返ってくるのを確認します。...

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

想定読者
  1. APIサーバーの実装の流れを理解したい方
  2. ルーティング設定と実処理を分離した書き方を知りたい方

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

この記事を読み終えた後のあなた
  • ルーティング(Router)と実処理(Controller)を分離して、紐付ける実装方法がわかる

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

今回の内容
  1. 事前準備 : 必要なライブラリのインストール
  2. ルーティング用のファイルと実処理用のファイルを分けて、紐付ける
  3. サーバーを起動して、APIの動作を確認する

事前準備 : 必要なライブラリのインストール

expressをインストール

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

expressをインストールした様子expressをインストールした様子

expressのインストール方法は、以前書いた記事「expressをインストールする【Node.jsのフレームワーク】」でも解説しているので、そちらも参考にしていただけたらと思います。

nodemonをインストール

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

nodemonをインストールした様子nodemonをインストールした様子

nodemonの導入の流れは、以前書いた記事「nodemonでサーバー開発を効率化する【修正後に自動再起動】」でも解説しているので、そちらも参考にしていただけたらと思います。

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

実処理の実装用ファイル : controllers/todos.jsを作成する

以下の画像のように、「controllers」ディレクトリを作成して、その中にtodos.jsを作成します。(※画像をクリックすると別タブで画像が開きます)

controllers/todos.jsを作成した様子controllers/todos.jsを作成した様子

「controllers/todos.js」にはgetTodosメソッドを用意して、外部から実行できるように、module.exportsで公開しておきます。

上の画像の右の赤枠内にgetTodosメソッドを実装していますが、中身はまだ実装していません。

getTodosメソッドの中身は後ほど実装するので、今はこのままで問題ありません。

ルーティング設定用ファイル : routers/todos.jsを作成する

以下の画像のように、「routers」ディレクトリを作成して、その中にtodos.jsを作成します。(※画像をクリックすると別タブで画像が開きます)

routers/todos.jsを作成した様子routers/todos.jsを作成した様子

「express.Router」でrouterオブジェクトを作成したら、以下のコードを実装します。(上の画像のの部分)

router.route(/).get(controller.getTodos)

このコードが意味することは次のとおりです。

  1. router.route(/) : 「/」、つまりルートにリクエストが来た時の処理を紐付ける
  2. get(controller.getTodos) : HTTPメソッドのGETでリクエストが来たら、「controller.getTodos」メソッドを実行する

つまり、「GET /」でリクエストが来たときに「controller.getTodos」メソッドを実行するということになります。

controller.getTodosメソッドは、先ほど作成した「controller/todos.js」内に実装したgetTodosメソッドを指します。

ここまででルーティングの設定(=Router)と実処理(=Controller)の紐付けが完了しました。

あとは、Controllerに実装したgetTodosメソッドの中身を実装して、サーバー起動周りのコードを実装すれば完成です。

Controllerの実処理を実装する

「controllers/todos.js」のgetTodosメソッドの実装内容は以下の画像の左側のコードになります。(※画像をクリックすると別タブで画像が開きます)

ControllerのgetTodosメソッドの実装その1ControllerのgetTodosメソッドの実装その1

getTodosメソッド内でやっている内容を順番に説明すると、前回記事「【APIサーバー】データ一覧取得する機能の追加【Model実装】」で作成したModelのfindAllメソッドを使って次の2つを行っているだけです。

  1. ModelのfindAllメソッドでデータ一覧を取得する
  2. 取得したデータ一覧を「res.json」メソッドを使ってクライアントに返す

詳しくは以下の画像内に書かれている説明も読んでいただけたらと思います。(※画像をクリックすると別タブで画像が開きます)

ModelのfindAllメソッドを実行してデータ一覧を取得ModelのfindAllメソッドを実行してデータ一覧を取得
取得したデータ一覧をres.jsonメソッドを使ってクライアントに返す取得したデータ一覧をres.jsonメソッドを使ってクライアントに返す

サーバー起動周りのコードを実装して、Routerをapp.useする

RouterとControllerの実装は終わったので、後はサーバー起動周りのコードを実装して、Routerをapp.useで紐付けるだけです。

Routerをapp.useで紐付ける方法は「【express】2ページ分のルーティング処理を実装する【express.Router】」で解説しているので、そちらを参考にしていただけたらと思います。

ここでは、プロジェクトのルートディレクトリ直下に「index.js」を作成して、index.jsの中にサーバー起動周りのコードを実装します。

index.jsの中身のコードと、説明は以下の画像を参考にして頂けたらと思います。(※画像をクリックすると別タブで画像が開きます)

index.jsの用意

プロジェクトのルートディレクトリ直下にindex.jsを作成して、サーバー起動周りのコードを実装するプロジェクトのルートディレクトリ直下にindex.jsを作成して、サーバー起動周りのコードを実装する

Routerを読み込む

Routerを読み込むRouterを読み込む

Routerをapp.useでセットして、基準パスを「/api/todos」に設定

Routerをapp.useでセットして、apiの基準のパスを「/api/todos」に設定したRouterをapp.useでセットして、apiの基準のパスを「/api/todos」に設定した

「npm start」でサーバー起動するようにpackage.jsonを修正

「npm start」でサーバー起動できるようにする「npm start」でサーバー起動できるようにする

サーバーを起動して、APIの動作を確認する

ブラウザでAPIの実行結果を確認する

ここまででデータ一覧を取得するAPIの実装が完了したので、実際にサーバーを起動してブラウザのURL入力欄に「localhost:8080/api/todos」と打ち込んで実行してみましょう。

正しく実装ができていれば、以下の画像のように、データ一覧がJSON形式で表示されるようになります。(※画像をクリックすると別タブで画像が開きます)

「localhost:8080/api/todos」にアクセスしたときのブラウザの出力「localhost:8080/api/todos」にアクセスしたときのブラウザの出力

JSON形式でデータが返っているのは、ControllerのgetTodosメソッドで「res.json」を使ってデータをクライアントに返しているからです。

Chrome拡張「JSONView」でブラウザのJSON表示を見やすくする

こちらはインストールする必要はありませんが、JSONデータをブラウザで見やすくしたい場合は、「JSONView」というChrome拡張をインストールするとデータ内容が見やすくなるのでオススメです。

以下の画像は、先ほどのブラウザのデータ出力と同じもので、違いはChrome拡張である「JSONView」をインストールしているか、していないかの違いだけです。(※画像をクリックすると別タブで画像が開きます)

JSONViewをインストールしている状態でのブラウザのJSONデータの表示JSONViewをインストールしている状態でのブラウザのJSONデータの表示

まとめ

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

今回のまとめ
  • APIサーバーの開発に必要なライブラリをインストールした
  • RouterとControllerを実装して、ルーティングと実処理を紐付けた
  • サーバー起動周りのコードを実装して、Routerをapp.useでセットして、基準のパスを「/api/todos」とした
  • サーバーを起動して、ブラウザで「localhost:8080/api/todos」にアクセスしたJSON形式でデータ一覧が返ってくるのを確認した
  • Chrome拡張「JSONView」の紹介をした

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

あわせて読みたい
【Controller実装】Todo一覧を取得するAPIを実装する今回はAPIサーバーのControllerを作成して、Todo一覧を取得するAPIを実装します。また、作成したControllerとRouterを紐づけてルーティングの設定も行います。最後に、実装したAPIの挙動を確認するためにWebブラウザにアクセスして、Todo一覧が返ってくるのを確認します。...
【やる気満々な方向け】学習サポートとオンライン講義やってます!

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日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

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