ノード。jsは、ChromeのV8Javascriptエンジン上に構築されたJavascriptランタイムです。 ノードは、スケーラブルなネットワークアプリケーションを構築するように設計されています。 この記事では、Nodeを使用してREST APIを構築することに焦点を当てています。js”を発表した。 私たちは、基本的な計算を行い、生成された出力を返す簡単な電卓サービスを構築します。REST APIとは何ですか?
単にRESTful APIは、HTTP要求を使用してデータを取得、投稿、PUT、削除するアプリケーションプログラマーインターフェイス(API)です。 RESTful webサービスとも呼ばれます。 RESTは、Webサービスを開発するためのアーキテクチャスタイルであるREpresentational State Transferの略です。
私たちは何を構築しようとしていますか?いくつかの計算を行い、値を返す単純なwebサービスを構築します。 要求Urlと出力は次のようになります。
あなたが必要なもの
- Visual Studio Codeのような素敵な小さなコードエディタ。
- ノード。jsがシステムにインストールされています。
- サービスフレームワーク—この記事では、私はhapiを使用しています。js(幸せなJSとして発音)
- 郵便配達員のようなアプリ(chromeアプリの拡張機能)私たちのサービスをテストします。私はmacOS High Sierraバージョン10.13.3にいます。 シェルコマンドは、他のプラットフォームでも同様である必要があります。p>
始めることができます
完全な作業サンプルを取得するにはここをクリックしてください。
まず、ノードのバージョンを確認する必要があります。あなたが持っているjs。 ターミナルを開き、次のコマンドを入力してノードのバージョンを確認します。あなたが持っているjs。 私はバージョン8.9を使用しています。4
$ node --version
さて、コードを格納するディレクトリを作成し、次のシェルコマンドを使用してそこに移動します。p>
$ mkdir calc-service
$ cd calc-service
私たちのプロジェクトを作成しましょう。このコマンドを入力することにより、jsonファイル。p>
$ npm init
質問とあなたのプロジェクトに答えます。jsonファイルは次のようになります。P>
いいですね、今、私たちのノードのベースを作成しました。jsサービス。 次に、hapiをインストールする必要があります。jsフレームワーク。 ハピjsは、豊富なフレームワークを使用すると、webアプリケーションだけでなく、ノードに基づいてサービスを作成することができますです。js”を発表した。
端末に移動して、次のコマンドを入力します。
$ npm install --save [email protected]
npmは、ノードで動作するように何千ものモジュールをインストールできるパッケージマネージャーです。js”を発表した。 上記のコマンドを見ると、hapiバージョン17をインストールするようにnpmに指示しました。 また、我々はパッケージを更新するように求めています。保存オプションを使用したjsonファイル。これで、フォルダ構造は次のようになります。
div>
ハピ。jsは依存関係として更新されました あなたがhapiを見るように。パッケージ内のjs依存関係が更新されました。jsonファイルと必要なnode_modulesが更新されます。
今すぐサーバーを作成しましょう
このステップでは、要求をリッスンするサーバーを作成します。 ターミナルでは、次のコマンドを入力してサーバーを作成します。jsファイル。 これは、あなたがいるディレクトリのルートにある必要があります。 または、VS Codeの左側のペインタブで新しいファイルを使用することもできます。div>
新しいファイルを作成します サーバーに次のコードを追加しましょう。jsファイル。 このコードは、指定されたポートでユーザー要求をリッスンするコードを作成します。p>
サーバーが起動して実行されているかどうかを確認しましょう。 ターミナルを開き、次のコマンドを実行します。p>
$ node server.js
そして、あなたはこのようなout putが表示されるはずです。div>
最初のルートを作成します
これで、サーバーのテストに成功しました。 私たちのサーバーは今稼働しています。 これは、最初のルートを作成する時間です。 このパスを作成して簡単に始めましょう。p>
/calculator/about
サーバーを開きます。jsファイルを作成し、init()の直前に次のコードを追加します。上記のコードは、GETメソッドの使用に関する/calculator/のgiveパスへのルートを作成します。 4行目のハンドラ関数では、要求を処理し、応答として応答を送り返します。 5行目では、JSON文字列を格納する変数を作成しました。 最後に、lineはその変数をサーバーからの応答として返します。これで、サーバーへの最初のルートが追加されました。 新しいコードを簡単にテストしましょう。 ターミナルで、サーバーを起動するには、次のコマンドを入力します。 (あなたはCTRL+Cを押してサーバーを停止することができます)
$ node server.js
POSTMANを起動して最初のルートをテストしましょう。div>
ルートをテストするサーバーから正常に戻ります。ご覧のとおり、GETメソッドを使用してリクエストを送信しましたが、URLはルートのパスと一致します。 サーバーからJSON文字列として正常に返されました。
優れた私たちは今、作業コードを持っています。 コードを少し整理することをお勧めします。 これは小さなアプリですが、それは常にそれを行うことをお勧めします。 ルーティングコードを別のフォルダとファイルに移動しましょう。
端末でCTRL+Cを押して、最初にサーバーを停止します。 ルートディレクトリにroutesという名前のディレクトリを作成します。 端末で次のコマンドを使用するか、VS Codeを使用して作成できます。
$ mkdir routes
$ cd routes
$ touch routes.js
ディレクトリ構造は次のようになります。
今、ルートを開きます。VSコード内のjsファイル。 次に、サーバーにルーティングするために書いたコードをカットします。jsファイル。 そして、ルートの中に貼り付けます。jsファイル。 今度は再びサーバーを開きます。jsファイルinit()メソッド呼び出しの直前に次のコードを追加します。P>
require(‘./routes/routes’)(server);
今、私たちは少し整理されたコードを持っています。 残りのルートをルートに追加します。jsファイル。
今、すべてのルートはそのままです。 行番号19、36、53、および70を見ると、パスには{}括弧内に2つのエントリがあります。 これらはパス内のパラメータとして扱われます。 これらのパラメータには、22行目と23行目に示すようにアクセスできます。 残りは自明です。
ターミナルでこのコマンドを入力してサーバーをスター化し、POSTMANを使用してテストします。
$ node server.js
Congratulations. You have written your first Node.js based REST API service.
Happy Coding 🙂 !!!
始めることができます
完全な作業サンプルを取得するにはここをクリックしてください。
まず、ノードのバージョンを確認する必要があります。あなたが持っているjs。 ターミナルを開き、次のコマンドを入力してノードのバージョンを確認します。あなたが持っているjs。 私はバージョン8.9を使用しています。4
$ node --version
さて、コードを格納するディレクトリを作成し、次のシェルコマンドを使用してそこに移動します。p>
$ mkdir calc-service
$ cd calc-service
私たちのプロジェクトを作成しましょう。このコマンドを入力することにより、jsonファイル。p>
$ npm init
質問とあなたのプロジェクトに答えます。jsonファイルは次のようになります。P>
いいですね、今、私たちのノードのベースを作成しました。jsサービス。 次に、hapiをインストールする必要があります。jsフレームワーク。 ハピjsは、豊富なフレームワークを使用すると、webアプリケーションだけでなく、ノードに基づいてサービスを作成することができますです。js”を発表した。
端末に移動して、次のコマンドを入力します。
$ npm install --save [email protected]
npmは、ノードで動作するように何千ものモジュールをインストールできるパッケージマネージャーです。js”を発表した。 上記のコマンドを見ると、hapiバージョン17をインストールするようにnpmに指示しました。 また、我々はパッケージを更新するように求めています。保存オプションを使用したjsonファイル。これで、フォルダ構造は次のようになります。
div>
あなたがhapiを見るように。パッケージ内のjs依存関係が更新されました。jsonファイルと必要なnode_modulesが更新されます。
今すぐサーバーを作成しましょう
このステップでは、要求をリッスンするサーバーを作成します。 ターミナルでは、次のコマンドを入力してサーバーを作成します。jsファイル。 これは、あなたがいるディレクトリのルートにある必要があります。 または、VS Codeの左側のペインタブで新しいファイルを使用することもできます。div>
サーバーに次のコードを追加しましょう。jsファイル。 このコードは、指定されたポートでユーザー要求をリッスンするコードを作成します。p>
サーバーが起動して実行されているかどうかを確認しましょう。 ターミナルを開き、次のコマンドを実行します。p>
$ node server.js
そして、あなたはこのようなout putが表示されるはずです。div>
最初のルートを作成します
これで、サーバーのテストに成功しました。 私たちのサーバーは今稼働しています。 これは、最初のルートを作成する時間です。 このパスを作成して簡単に始めましょう。p>
/calculator/about
サーバーを開きます。jsファイルを作成し、init()の直前に次のコードを追加します。上記のコードは、GETメソッドの使用に関する/calculator/のgiveパスへのルートを作成します。 4行目のハンドラ関数では、要求を処理し、応答として応答を送り返します。 5行目では、JSON文字列を格納する変数を作成しました。 最後に、lineはその変数をサーバーからの応答として返します。これで、サーバーへの最初のルートが追加されました。 新しいコードを簡単にテストしましょう。 ターミナルで、サーバーを起動するには、次のコマンドを入力します。 (あなたはCTRL+Cを押してサーバーを停止することができます)
$ node server.js
POSTMANを起動して最初のルートをテストしましょう。div>
優れた私たちは今、作業コードを持っています。 コードを少し整理することをお勧めします。 これは小さなアプリですが、それは常にそれを行うことをお勧めします。 ルーティングコードを別のフォルダとファイルに移動しましょう。
端末でCTRL+Cを押して、最初にサーバーを停止します。 ルートディレクトリにroutesという名前のディレクトリを作成します。 端末で次のコマンドを使用するか、VS Codeを使用して作成できます。
$ mkdir routes
$ cd routes
$ touch routes.js
ディレクトリ構造は次のようになります。
今、ルートを開きます。VSコード内のjsファイル。 次に、サーバーにルーティングするために書いたコードをカットします。jsファイル。 そして、ルートの中に貼り付けます。jsファイル。 今度は再びサーバーを開きます。jsファイルinit()メソッド呼び出しの直前に次のコードを追加します。P>
require(‘./routes/routes’)(server);
今、私たちは少し整理されたコードを持っています。 残りのルートをルートに追加します。jsファイル。
今、すべてのルートはそのままです。 行番号19、36、53、および70を見ると、パスには{}括弧内に2つのエントリがあります。 これらはパス内のパラメータとして扱われます。 これらのパラメータには、22行目と23行目に示すようにアクセスできます。 残りは自明です。
ターミナルでこのコマンドを入力してサーバーをスター化し、POSTMANを使用してテストします。
$ node server.js
Congratulations. You have written your first Node.js based REST API service.
Happy Coding 🙂 !!!