Node.js で REST API を作成する方法

この記事では、Node.js で基本的な REST API を作成する方法について、エンド ツー エンドのフローを見ていきます。
絶対的な基本から始めますので、何の問題もありません。

はじめましょう。

1. 以下のコマンドを使用して、基本的なノード プロジェクトを作成します。

npm init -y

npm install express

const express = require('express');

const app = express();

app.listen(3000, () => {
  console.log('Server is running on Port 3000');
});

node server.js

これは、ノード アプリケーションのセットアップに必要な基本的な足場です。

ここで、単純な文字列「Welcome to Hello End point」を返す単純なget API を作成します。

同じプロジェクトにルーター フォルダーを作成し、以下の内容のファイル applicationRoute.js を作成します。

const express = require('express');      // Step 1 

const router = express.Router();   // Step 2

router.get('/getHello', helloController);   // Step 3

module.exports = router;   // Step 4

1. Express をローカル変数にインポートします。
2. これは、エクスプレスでルートを設計する際の最も重要なステップです。Express は、ルーター オブジェクトを作成してエンドポイントを効率的に作成するのに役立つルーター関数を公開します。ここでは、オブジェクトをルーター変数に格納しています。
3. 次に、ステップ 2 で作成したルーター オブジェクトを使用して、目的のエンド ポイントを作成します。以下の画像は、完全な構文の構造を示しています。

4. Router オブジェクトは、手順 2 で作成したオブジェクトです。
5. HTTP 動詞は、GET、POST、PUT、または DELETE などの従来の http アクションです。
6. エンドポイント文字列は、作成するエンドポイントです。
7. コントローラーは、データ操作などのエンドポイントのビジネス ロジックを実装し、ここからの応答を送信する機能です。
8. コントローラーに似た複数のミドルウェア機能を使用することもできますが、この記事ではミドルウェアについて深く掘り下げません。

server.js を変更し、以下の新しい行を追加して、作成されたルート (この場合は applicationRoutes) への目的のルートを構成できるようにします。

const express = require('express');
const router = require('./Routes/applicationRoutes');   // Step 1 

const app = express();   

app.use('/demo', router);                           // Step 2

app.listen(3000, () => {
  console.log('Server is running on Port 3000');
});

1. ルーターを使用して、「デモ」ルートを指すすべてのアプリケーション ロジックをルーター ロジックにルーティングします。

1つを除いてすべての端が接続されており、それがコントローラーです.(最も重要なもの).さて、それをしましょう.

routes フォルダーと並行してフォルダーを作成し、applicationController.js という名前のファイルを作成して、以下のロジックを追加します。

module.exports = {
  helloController: (req, res) => {
    res.status(200).send('Welcome to Hello End point'); // Step 1
  },
};

それでは、postman を使用してすべての動作を一緒に見てみましょう。



上記から明らかなように、期待どおりに正常に応答を得ることができます。

Express を使用して NodeJS でエンドポイントを作成する方法に関する基本的なアイデアを得ることができたことを願っています。完全なコードについては、リンクを参照してください。

次のチュートリアルでは、POST エンドポイントを作成する方法について深く掘り下げて理解します。
ご不明な点がございましたら、返信でお知らせください。

自己紹介 — 私はプログラミング愛好家で、フロントエンド デザイン、JavaScript、および UI/UX 関連のものについて読み書きするのが好きです。ここをクリックして私の記事をすべて読み、フィードバックをお寄せください。

その他のコンテンツはPlainEnglish.ioにあります。無料の週刊ニュースレターにサインアップしてください。Twitter、LinkedIn、YouTube、Discordでフォローしてください。

ソフトウェアスタートアップのスケーリングに興味がありますか? サーキットをチェックしてください。