APIって何? プログラミング初心者向けNode.js入門ガイド

ブラウザがデータを要求し、サーバーが結果を返す。このリクエストとレスポンスを、自分のPCで小さく試すのが今回の目標です。Node.jsを使い、JSONを返すWeb APIを作ります。JavaScriptの関数と、ターミナルの基本操作を知っている方向けです。

Node.jsはブラウザの外でJavaScriptを動かす実行環境

JavaScriptはブラウザだけで動く言語ではありません。Node.jsは、JavaScriptをサーバーや開発用PCなどで実行するための環境です。Web API、ファイル処理、開発ツールなどに使えます。画面のdocumentなど、ブラウザ固有の機能がそのまま使えるわけではありません。

Node.jsには非同期I/Oの仕組みがありますが、大量のアクセスが必ず高速に処理できるという意味ではありません。重い計算や同期処理が他の処理を待たせることもあり、負荷に応じた設計が必要です。

Web APIはデータをやり取りする窓口

天気アプリを例にすると、アプリが地域を指定してデータを要求し、サーバーが気温などを返します。Web APIには、要求先のURL、HTTPメソッド、渡す値、返す形式などの取り決めがあります。今回はGETで/helloへアクセスすると、messageを含むJSONを返す窓口を作ります。

準備:Node.jsを確認し、専用フォルダを作る

Node.js公式ダウンロードから、使っているOSに対応するサポート中のLTS版を用意してください。インストール後、ターミナルでnode --versionを実行し、バージョンが表示されるか確認します。操作が初めてならターミナル入門を先に確認してください。

新しい練習用フォルダを作り、その中にserver.cjsを保存します。既存プロジェクトと混ぜず、次のコードをプレーンテキスト・UTF-8で保存してください。この例はNode.jsの標準機能を使うため、Expressなどの追加パッケージは不要です。

const http = require('node:http');

const server = http.createServer((req, res) => {
  res.setHeader('Content-Type', 'application/json; charset=utf-8');
  if (req.method === 'GET' && req.url === '/hello') {
    res.writeHead(200);
    res.end(JSON.stringify({ message: 'こんにちは、API' }));
    return;
  }
  res.writeHead(404);
  res.end(JSON.stringify({ error: 'Not found' }));
});

server.listen(3000, '127.0.0.1', () => {
  console.log('http://127.0.0.1:3000/hello を開いてください');
});

ターミナルでserver.cjsを保存したフォルダへ移動し、次を実行します。

node server.cjs

ブラウザでhttp://127.0.0.1:3000/helloを開きます。{"message":"こんにちは、API"}と表示されれば成功です。サーバーを動かしている間はターミナルを開いたままにします。終了するときはCtrl+Cを押してください。

200と404を比べて、APIの役割を確かめる

/helloを/testに変えると、Not foundというJSONを返します。ブラウザの開発者ツールのNetworkで再読み込みし、/helloでは200、/testでは404になることを確認します。表示するJSONだけでなく、HTTPのステータスコードも結果を伝えます。

127.0.0.1は自分のPCを指すアドレスです。この練習は手元だけで動かす構成であり、インターネットへ公開する手順ではありません。認証や入力の検証などを備えていないため、そのまま公開用APIとして使わないでください。

起動しない・表示されないとき

  • nodeが見つからない:インストールとPATHの設定を確認し、ターミナルを開き直します。
  • Cannot find module:現在のフォルダ、server.cjsの名前・拡張子を確認します。
  • EADDRINUSE:同じポートを他のアプリが使用しています。自分の前回の練習サーバーなら停止するか、コードの3000とアクセス先を同じ別番号に変えます。
  • 接続できない:サーバーが起動中か、URLとポートが一致するか確認します。
  • 変更が反映されない:保存後にCtrl+Cで停止し、再度node server.cjsで起動します。

次の練習:返すデータを変える

messageの文章を変え、再起動して表示を確認してください。次にJSONへlesson: "Node.js"という項目を追加してみましょう。要求を受けた場所と、返す値を作る場所が説明できれば、この練習の到達点です。複数の窓口が増える段階でExpressなどのフレームワークや、Promise/async・awaitを学ぶと用途を理解しやすくなります。

参考:Node.js公式「Introduction to Node.js」。

次に読む記事

学習の進め方や質問先を検討する

エラーを質問するときは、実行したコマンド、エラー文、期待したJSONをそろえてください。 CodeNestでは、AIへの質問や演習を通じたプログラミング学習を案内しています。対応する学習内容・必要な環境・利用条件をCodeNestの公式案内で確認し、今の課題に合うかを検討してください。