【Next.js】APIルートとは

APIルートとは

Next.jsのAPIルートは、Next.jsアプリケーション内でサーバーレスのAPIエンドポイントを定義するための特別なディレクトリです。このディレクトリ内のファイルは、サーバーサイドで実行されるAPIエンドポイントとして機能し、クライアントからのリクエストに対してデータを返すことができます。

通常、APIルートは/pages/apiディレクトリに配置されます。このディレクトリ内の各ファイルは、HTTPリクエストに対応するAPIエンドポイントを表します。たとえば、/pages/api/users.jsファイルは/api/usersパスに対応し、ユーザーに関するデータを返すAPIエンドポイントとして機能します。

APIルートのファイルは、通常のReactコンポーネントとは異なり、以下のルールに従う必要があります。

1. ファイルのエクスポートは、APIエンドポイントのハンドラー関数である必要があります。この関数は、リクエストオブジェクトとレスポンスオブジェクトを受け取り、データを返す役割を果たします。

2. APIルートのファイルは、サーバーサイドでのみ実行されることを意味するため、クライアントサイドのコードは含まれません。

以下は、簡単なAPIルートの例です。

// pages/api/hello.js

export default function handler(req, res) {
  res.status(200).json({ message: 'Hello, Next.js API!' });
}

このファイルは、/api/helloエンドポイントにアクセスした際に{ message: 'Hello, Next.js API!' }というJSONデータを返します。APIルートを使用することで、Next.jsアプリケーション内で簡単にサーバーレスのAPIを作成し、クライアントからのリクエストに応答することができます。