見出し画像

Node.jsとExpressを使ったRESTful APIの開発スタートガイド

Node.jsとExpressフレームワークを使用して、シンプルなRESTful APIを構築する基本的な手順を説明します。
今回はNode.jsおよびExpressのインストールから、ローカルサーバーの立ち上げまでの手順を解説します。


1. 環境設定


winget

wingetを使用します。windows11には標準ですが、コマンドプロンプトやPowerShellで以下のコマンドを実行してインストールされていない場合は、その下の記事を参考にインストールして下さい。

winget -v

node.js

Node.js(npm)を使用します。インストールしていない場合は以下のコマンドでインストールしましょう。

winget install OpenJS.NodeJS

VSCode(任意)

ターミナルとメモ帳でも可能ですが、説明ではVSCodeも使用します。
インストールする場合は以下のコマンドでインストールしましょう。

winget install Microsoft.VisualStudioCode


2. プロジェクトの初期化


プロジェクトとして適当なフォルダを作成してVSCodeを開き、ターミナルを表示します。直接ターミナルで開いてもokです。

VSCode ターミナル


3. Expressのインストール


以下のコマンドを実行してExpressをインストールします。

npm install express


4. API作成


プロジェクトルートにindex.jsファイルを作成し、以下のサンプルコードを追加して、基本的なRESTful APIサーバーをセットアップします。
この設定では3000番ポートでリスニングし、ルートと/usersでそれぞれjsonを返します。

const express = require('express')
const app = express()
const port = 3000

app.get('/', (req, res) => {
  res.json({ message: 'Welcome to the root endpoint!' })
})

app.get('/users', (req, res) => {
  res.json([
    { id: 1, name: 'John Doe' },
    { id: 2, name: 'Jane Doe' },
  ])
})

app.listen(port, () => {
  console.log(`Example app listening at http://localhost:${port}`)
})
index.js

5. サーバー起動


サーバーを起動するには、ターミナルで以下のコマンドを実行します。

node index.js

ブラウザ等で下記のURLにアクセスし、コード内で記述しているjsonが返されていることを確認してみましょう。

  • http://localhost:3000/

  • http://localhost:3000/users

http://localhost:3000にアクセス
http://localhost:3000/users


今回はここまでです。読んで頂きありがとうございました。



この記事が気に入ったらサポートをしてみませんか?