ホームページ > ウェブフロントエンド > jsチュートリアル > Express.js を使用して API を構築するための初心者ガイド

Express.js を使用して API を構築するための初心者ガイド

Patricia Arquette
リリース: 2024-12-01 08:17:15
オリジナル
488 人が閲覧しました

A Beginner’s Guide to Building APIs with Express.js

API (アプリケーション プログラミング インターフェイス) は最新の Web アプリケーションのバックボーンであり、フロントエンドとバックエンド間の通信を可能にします。 JavaScript で API を構築するための最も人気のあるツールの 1 つは、最小限で柔軟な Node.js フレームワークである Express.js です。このガイドでは、Express.js を使用した API 構築の基本を説明します。

Express.js とは何ですか?
Express.js は、Node.js を使用してサーバー側アプリケーションを構築するための軽量フレームワークです。これにより、HTTP リクエストの処理、ルーティング、ミドルウェア統合などのタスクが簡素化され、API を作成するための優れた選択肢となります。

Express.js を使用する理由

  • 使いやすさ: シンプルな構文と素早いセットアップ。
  • 柔軟性: ミドルウェアを使用してカスタマイズして、認証、ロギング、エラー処理などの機能を追加できます。
  • スケーラビリティ: 小規模なアプリケーションと大規模なアプリケーションの両方に適しています。

Express.js 環境のセットアップ

ステップ 1: Node.js をインストールする
Node.js がインストールされていることを確認してください。必要に応じて、nodejs.org からダウンロードします。

ステップ 2: プロジェクトを初期化する
新しいプロジェクト ディレクトリを作成し、初期化します。

mkdir express-api  
cd express-api  
npm init -y 
ログイン後にコピー
ログイン後にコピー

これにより、依存関係を管理するための package.json ファイルが作成されます。

ステップ 3: Express.js をインストールする
npm:
を使用して Express.js をインストールします。

npm install express  
ログイン後にコピー
ログイン後にコピー

最初の API を構築する

ステップ 1: 基本サーバーを作成する
まず、server.js ファイルを作成し、次のコードを追加します。

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

app.listen(PORT, () => {  
  console.log(`Server is running on http://localhost:${PORT}`);  
});  
ログイン後にコピー
ログイン後にコピー

次のコマンドでサーバーを実行します:

node server.js 
ログイン後にコピー

http://localhost:3000 にアクセスすると、サーバーが実行中であることがわかります (ただし、まだ何も返されません)。

ステップ 2: 最初のルートを定義する
ルートは、API がクライアントのリクエストにどのように応答するかを定義します。ウェルカム メッセージを返すための簡単なルートを追加します:

app.get('/', (req, res) => {  
  res.send('Welcome to your first Express API!');  
});  
ログイン後にコピー

サーバーを再起動すると、http://localhost:3000 にアクセスするとメッセージが表示されます。

ステップ 3: API エンドポイントを作成する
データを処理するエンドポイントを追加しましょう。たとえば、ユーザーのリストを返す /users ルート:

const users = [  
  { id: 1, name: 'Alice' },  
  { id: 2, name: 'Bob' },  
  { id: 3, name: 'Charlie' }  
];  

app.get('/users', (req, res) => {  
  res.json(users);  
}); 
ログイン後にコピー

http://localhost:3000/users にアクセスすると、ユーザー データが JSON 形式で返されるようになりました。

ミドルウェアの追加
Express.js のミドルウェア関数は、リクエストと応答を処理します。たとえば、ミドルウェアを使用して、クライアントから送信された JSON データを解析できます。

ステップ 1: 組み込みミドルウェアを使用する
JSON 解析を有効にするには、以下を追加します:

app.use(express.json());  
ログイン後にコピー

ステップ 2: POST リクエストを処理する
ルートを追加して新しいユーザーを作成します:

mkdir express-api  
cd express-api  
npm init -y 
ログイン後にコピー
ログイン後にコピー

これで、JSON データを含む POST リクエストを http://localhost:3000/users に送信して、新しいユーザーを追加できるようになりました。

エラー処理
エラーを適切に処理するには、ミドルウェアを使用します。例:

npm install express  
ログイン後にコピー
ログイン後にコピー

これにより、未処理のエラーが発生しても意味のある応答が返されます。

最終コード
完全な例は次のとおりです:

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

app.listen(PORT, () => {  
  console.log(`Server is running on http://localhost:${PORT}`);  
});  
ログイン後にコピー
ログイン後にコピー

結論
Express.js を使用すると、API の構築が簡単かつ効率的になり、すぐに開始するために必要なツールと柔軟性が提供されます。ルートの設定、データの処理、ミドルウェアの使用の基本を理解することで、Web アプリケーション用の強力な API を作成できます。

認証、データベース統合、高度なエラー処理などの機能を探索し続けて、API を次のレベルに引き上げてください。

以上がExpress.js を使用して API を構築するための初心者ガイドの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。

ソース:dev.to
このウェブサイトの声明
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。
著者別の最新記事
人気のチュートリアル
詳細>
最新のダウンロード
詳細>
ウェブエフェクト
公式サイト
サイト素材
フロントエンドテンプレート