🚀 はじめに

Node.js Express API 開発は、Web アプリケーションのバックエンド構築に不可欠なスキルです。本記事では、初心者から中級者まで、Express API 開発の基礎から応用までを網羅的に解説します。API の設計、実装、テスト、デプロイメントまで、一連のプロセスをステップバイステップで学びましょう。本記事を読めば、すぐに API 開発を始められるでしょう。

📚 基礎知識

Express は Node.js の Web アプリケーションフレームワークであり、ルーティング、ミドルウェア、テンプレートエンジンなどの機能を提供します。API 開発においては、これらの機能を活用して、効率的に API を構築することができます。

開発環境のセットアップ

まず、Node.js と npm (Node Package Manager) をインストールする必要があります。Node.js の公式サイトから最新の安定版をダウンロードしてインストールしてください。その後、ターミナルで次のコマンドを実行して、Express をプロジェクトにインストールします。

npm init -y
npm install express

ルーティングの実装

ルーティングは、クライアントからのリクエストを適切なハンドラ関数に振り分ける役割を担います。Express では、`app.get()`, `app.post()`, `app.put()`, `app.delete()` などのメソッドを使用してルーティングを定義します。

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

app.get('/', (req, res) => {
  res.send('Hello World!');
});

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

このコードは、ルートパス `/` にアクセスされた際に “Hello World!” を返すシンプルな API を定義しています。

ミドルウェアの活用

ミドルウェアは、リクエストとレスポンスの間に挟まれ、リクエストの処理やレスポンスの修正を行うための関数です。ロギング、認証、エラーハンドリングなど、様々な目的で使用されます。

const express = require('express');
const app = express();
const logger = (req, res, next) => {
  console.log(`[${new Date().toISOString()}] ${req.method} ${req.url}`);
  next();
};

app.use(logger);

app.get('/', (req, res) => {
  res.send('Hello World!');
});

このコードでは、`logger` というミドルウェアを定義し、すべてのリクエストのログをコンソールに出力しています。

データベース連携

API は、しばしばデータベースと連携してデータを取得したり、保存したりする必要があります。ここでは、MongoDB と連携する例を示します。

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

mongoose.connect('mongodb://localhost:27017/mydatabase', { useNewUrlParser: true, useUnifiedTopology: true })
  .then(() => console.log('Connected to MongoDB'))
  .catch(err => console.error('MongoDB connection error:', err));

// モデルの定義 (例)
const ItemSchema = new mongoose.Schema({
  name: String,
  description: String
});

const Item = mongoose.model('Item', ItemSchema);

app.get('/items', async (req, res) => {
  try {
    const items = await Item.find({});
    res.json(items);
  } catch (err) {
    res.status(500).json({ message: err.message });
  }
});

エラーハンドリング

API は、予期せぬエラーが発生する可能性があります。エラーハンドリングを適切に行うことで、API の信頼性を高めることができます。

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

app.get('/error', (req, res, next) => {
  const error = new Error('Something went wrong!');
  error.status = 500;
  next(error);
});

app.use((err, req, res, next) => {
  res.status(err.status || 500);
  res.json({
    error: {
      message: err.message
    }
  });
});

認証と認可

API を保護するために、認証と認可を実装する必要があります。JWT (JSON Web Token) を使用した認証の例を示します。

デプロイメント

API を公開するために、デプロイメントを行う必要があります。Heroku や AWS などのクラウドプラットフォームを使用することができます。

ベストプラクティス

API の設計においては、RESTful な原則に従うことが重要です。

API のドキュメントを整備し、開発者が容易に利用できるようにすることが重要です。

🎉 まとめ