Node.js

Node.jsのExpressを使ってAPIエンドポイントを作ってみる

はじめに

Node.jsのWebフレームワークであるExpressなるものを使うと、RESTfulなAPI(エンドポイント)を簡単に作れると知ったので、軽く触ってみる。

本記事のゴール

作成したエンドポイントに対してGetリクエストを投げて、「Hello Express!」が表示されるまで

環境

  • Windows 10 64bit
  • Node.js:19.1.0
  • Express:4.18.2

事前準備

Node.jsのインストールが必要だが手順の詳細は割愛。

公式サイトからダウンロードしてインストールする。

Expressアプリケーション構築手順

プロジェクトディレクトリ作成

ターミナルを開き、今回用のプロジェクトディレクトリを作成する。

mkdir express-app
cd express-app

プロジェクトの初期化

次にプロジェクトを初期化する。これにより、package.json ファイルが作成される。

npm init -y

Expressのインストール

メインであるExpressをインストールする。

npm install express

アプリケーションの作成

プロジェクトディレクトリ内に、app.js ファイルを作成し、Expressアプリケーションを作成する。

const express = require('express');
const app = express();

// ルートエンドポイントの設定
app.get('/', (req, res) => {
    res.send('Hello Express!');
});

// サーバーの起動
const PORT = 3000;
app.listen(PORT, () => {
    console.log(`Server is running on port ${PORT}`);
});

今回はサーバの起動と、最低限のルートエンドポイント('/’)のみ記述する。

サーバーの起動

次のコマンドでサーバーを起動する。

node app.js

これにより、Expressサーバーがポート3000で実行され、リクエストを待っている状態になる。

なのでブラウザで http://localhost:3000 にアクセスすると、設定したルートエンドポイントが呼ばれ、画面上に"Hello Express!"というメッセージが表示される。

おわりに

今回は単純なルートエンドポイントへのGETリクエストのみ設定だけだったが、Expressを使うと簡単にバックエンドのエンドポイントを作成することができた。

ルート以外のエンドポイントの作成であったり、その他のHTTPメソッド(POST , DELETEなど)、そしてDBとの連携については今回試せていないので今後のアプリ開発なので試してみる。