ホームページ >ウェブフロントエンド >jsチュートリアル >node.jsとexpress.jsを使用してREST APIを作成する方法(初心者向け)

node.jsとexpress.jsを使用してREST APIを作成する方法(初心者向け)

Mary-Kate Olsen
Mary-Kate Olsenオリジナル
2025-01-28 06:35:12682ブラウズ

How to Create a REST API with Node.js and Express.js (for Beginners)

REST APIの構築は、バックエンド開発の基本的なスキルです。この記事では、node.js

およびexpress.jsの使用方法を導きます。このガイドは、最初のAPIを構築するための明確なステップごとのプロセスを提供します。 注:

このチュートリアルは、データベースを統合するのではなく、メモリアレイを使用します。

REST APIとは何ですか?


REST API

(同様の状態伝送アプリケーションプログラミングインターフェイス)は、構築およびインタラクティブなWebサービスのための一連のルールと合意です。 HTTPメソッド(Get、Post、Put、Deleteなど)を使用して操作を実行し、通常はJSON形式でデータを返します。

前提条件 開始する前に、次のコンテンツをインストールしていることを確認してください。


node.js

:nodejs.orgからダウンロードしてインストールします。

コードエディター

:ビジュアルスタジオコード、崇高なテキスト、アトムなど、好きなエディターを使用します。
  1. postman (オプション):APIのエンドポイントをテストするために使用されるツール。 postman.comからダウンロードしてください。
  2. ステップ1:プロジェクトを設定
  3. 1。プロジェクトディレクトリを作成します
  4. 端末を開き、プロジェクトの新しいディレクトリを作成します:
2。Node.jsプロジェクトを初期化

次のコマンドを実行してpackage.jsonファイルを作成します。

-Yロゴは、プロジェクトのデフォルト値を自動的に入力します。

ステップ2:必要なバッグを取り付けます
<code>mkdir my-rest-api
cd my-rest-api</code>

1。express.js

をインストールします

Express.jsはnode.jsの軽量のWebフレームワークです。次のコマンドを使用してインストールします

<code>npm init -y</code>
2。nodemon(オプション)

をインストールします

コードを変更するたびに、Nodemonはサーバーを自動的に再起動します。開発依存関係としてインストールします:

ステップ3:基本的なサーバーを作成

1。index.jsファイルを作成します

<code>npm install express</code>
プロジェクトディレクトリで、index.jsというファイルを作成します:

2。サーバーを設定します

<code>npm install --save-dev nodemon</code>
index.jsを開いて、次のコードを追加します:

3。サーバーを実行します

次のコマンドを使用してサーバーを起動します。

Nodemonをインストールする場合は、:
<code>touch index.js</code>
を使用してください

ブラウザでは、

https://www.php.cn/link/8cad09283d1d6c5fb08daec8a576a72d

、 "
<code class="language-javascript">// 导入 express 模块
const express = require('express');

// 创建 express 实例
const app = express();

// 定义端口号
const PORT = 3000;

// 解析 JSON 主体的中间件
app.use(express.json());

// 定义一个简单的路由
app.get('/', (req, res) => {
    res.send('Hello, World!');
});

// 启动服务器并在指定的端口上监听
app.listen(PORT, () => {
    console.log(`服务器正在运行在 http://localhost:${PORT}`);
});</code>

ステップ4:CRUD操作を追加

プロジェクトのリストを管理するためのシンプルなREST APIを作成しましょう。メモリアレイを使用してデータを保存します。

<code>node index.js</code>
1。メモリ配列を作成

この旅行の後にこの旅行を追加します:
<code>npx nodemon index.js</code>
<code>mkdir my-rest-api
cd my-rest-api</code>

2。crudルーティングを定義します

get /items:すべてのプロジェクトを取得

<code>npm init -y</code>
get /items /:id

:ID で単一のアイテムを取得します

投稿 /項目
<code>npm install express</code>
:新しいプロジェクトを作成

put /items /:id

:ID
<code>npm install --save-dev nodemon</code>
を介してプロジェクトを更新します

delete /items /:id:id

を介してプロジェクトを削除する
<code>touch index.js</code>

ステップ5:APIをテストします

Postman を使用<code class="language-javascript">// 导入 express 模块 const express = require('express'); // 创建 express 实例 const app = express(); // 定义端口号 const PORT = 3000; // 解析 JSON 主体的中间件 app.use(express.json()); // 定义一个简单的路由 app.get('/', (req, res) => { res.send('Hello, World!'); }); // 启动服务器并在指定的端口上监听 app.listen(PORT, () => { console.log(`服务器正在运行在 http://localhost:${PORT}`); });</code>または
curl

APIエンドポイントをテストします:

gethttps://www.php.cn/link/8a701b176cc1408888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888936DAD15D046A

POST
  1. https://www.php.cn/link/8a701b176cc140888888888888888888888888888888888888888936DAD15D046A-新しいプロジェクトを作成します。 に似たJSON本体を送信します。 gethttps://www.php.cn/link/8a701b176cc1408888888888888888888888888936DAD15D046A ——— IDを介して単一のアイテムを取得します。
  2. puthttps://www.php.cn/link/8a701b176cc14088888888888888888888888888888888888888888888888888936DAD15D046A>更新プロジェクト。 に似たJSON本体を送信します。 delete{"name": "项目 1"}
  3. https://www.php.cn/link/8a701b176cc14088888888888888888888888888888888888888888888888888888888888888888888888936DAD15D046A- IDを介してアイテムを削除します。
  4. ステップ6:エラートリートメント(オプション)を追加します
  5. グローバルにエラーを処理するには、このミドルウェアをindex.jsファイルの最後に追加します:
  6. ステップ7:コードを整理する(オプション) {"name": "已更新的项目 1"}プロジェクトの開発により、コードを別のファイルとフォルダーに編成できます。たとえば、
  7. routes/:ルートを定義します。 controller/
  8. :ビジネスロジックの処理。

モデル/

:データ構造を定義します。

<code>node index.js</code>
最終コード
これは完全なindex.jsファイルです:

結論
    おめでとうございます! node.jsとexpress.jsを使用してシンプルなREST APIを作成しました。これはほんの始まりに過ぎません - データベースの統合、IDの確認の追加、APIの展開など、より多くのことを実行することもできます。
  • やり続けてください、私はあなたに幸せなコーディングを願っています!

以上がnode.jsとexpress.jsを使用してREST APIを作成する方法(初心者向け)の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。

声明:
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。