HOWTO · Node.js

Node.js で REST API を呼び出す

今日の投稿では、Node.js で REST API を呼び出す方法について学びます。

このページの内容

RESTRepresentational State Transferの略です。 RESTAPI またはRESTfulAPI は、RESTアーキテクチャ スタイルの制約/制限に準拠し、RESTfulWeb サービスとの対話を可能にする API または Web API (アプリケーション プログラミング インターフェース) です。

本日の投稿では、Node.js を使用してサードパーティ パッケージを使用してリクエストを行う方法を学びます。

Node.js で REST API を呼び出す

HTTP GET メソッドは、サーバーからリソースを取得します。 たとえば、ブラウザは、サーバーから TODO データ リストをフェッチするとき、または特定の TODO リクエストの情報をフェッチするときに、HTTP GET リクエスト メソッドを使用します。

GET および HEAD リクエストは、サーバーの状態を変更しません。

GETAPI はべき等です。つまり、POSTPUTなどの別の API がサーバーに対して行われ、サーバー上のリソースの状態が変更されるまで、複数の同一のリクエストを行うと、毎回同じ結果が生成されます。

Axiosは無料のサードパーティ パッケージであり、ブラウザおよび Node.js 用の Promise ベースの HTTP クライアントです。 NPMで利用できます。

Axios を使用して、非同期 HTTP リクエストを REST エンドポイントに送信できます。 Axios を使用すると、CRUD 操作を簡単に実行できます。

Vanilla JavaScript で、または Node.js や Angular などのライブラリで使用できます。

このコマンド $ npm i axios を使用して Axios ライブラリをインストールします。

GET リクエストは get メソッドで作成されます。

const axios = require('axios');
async function getData() {
  const res = await axios.get('https://jsonplaceholder.typicode.com/todos/1');
  const data = res.data;
  console.log(data);
}
getData();

上記の例では、ユーザーがファイルを実行すると、GET 呼び出しが指定された URL (この投稿ではダミー) を使用して Node サーバーに送信されます。 サーバーがこのデータを中断することなく処理すると、成功メッセージが返されます。

サーバー応答の出力に基づいて、コンソールにメッセージを出力するか、適切なメッセージでユーザーに通知できます。

出力:

{ userId: 1, id: 1, title: 'delectus aut autem', completed: false }

デモ