Cara Membuat API REST dengan Node.js dan Express.js (untuk pemula)

Building REST API adalah kemahiran asas untuk pembangunan belakang. Artikel ini akan membimbing anda cara menggunakan node.js

dan express.js Buat API REST yang mudah. Panduan ini akan memberikan proses yang jelas, langkah -langkah untuk membina API pertama anda. <:> NOTA:

Tutorial ini tidak mengintegrasikan mana -mana pangkalan data, tetapi menggunakan array memori.

Apa itu API REST?

---

REST API

(antara muka pengaturcaraan aplikasi penghantaran negara yang sama) adalah satu set peraturan dan perjanjian untuk membina dan perkhidmatan web interaktif. Ia menggunakan kaedah HTTP (seperti Get, Post, Put, and Delete) untuk melaksanakan operasi, dan biasanya mengembalikan data dalam format JSON.

keadaan prasyarat Sebelum memulakan, pastikan anda telah memasang kandungan berikut:

---

node.js

: muat turun dan pasangnya dari nodejs.org.

Editor kod

: Gunakan mana -mana editor yang anda suka, seperti Kod Visual Studio, Teks Sublime atau Atom.
1. Postman (Pilihan): Alat yang digunakan untuk menguji titik akhir API anda. Muat turunnya dari postman.com.
2. Langkah 1: Tetapkan Projek Anda
3. 1. Buat direktori projek Buka terminal anda dan buat direktori baru untuk projek anda:

---

2. Inisialisasi Projek Node.js

Jalankan arahan berikut untuk membuat fail pakej.json:

-y logo akan secara automatik mengisi nilai lalai projek anda.

<code>mkdir my-rest-api
cd my-rest-api</code>

Langkah 2: Pasang beg yang diperlukan

1. Pasang Express.js

<code>npm init -y</code>

Express.js adalah rangka kerja web ringan Node.js. Gunakan arahan berikut untuk memasangnya:

---

2. Pasang Nodemon (Pilihan)

Apabila anda menukar kod, Nodemon akan memulakan semula pelayan anda secara automatik. Pasangnya sebagai kebergantungan pembangunan:

Langkah 3: Buat pelayan asas

<code>npm install express</code>

1. Buat fail index.js

Dalam direktori projek anda, buat fail yang dipanggil index.js:

<code>npm install --save-dev nodemon</code>

---

2. Tetapkan pelayan

Buka index.js dan tambahkan kod berikut:

3. Jalankan pelayan

<code>touch index.js</code>

Gunakan arahan berikut untuk memulakan pelayan:

Jika anda memasang Nodemon, sila gunakan:

<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>

dalam penyemak imbas, lawati

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

, dunia!

<code>node index.js</code>

Langkah 4: Tambah Operasi CRUD

Mari buat API REST yang mudah untuk menguruskan senarai projek. Kami akan menggunakan array memori untuk menyimpan data.

<code>npx nodemon index.js</code>

1. Buat Array Memori Tambahkan perjalanan ini selepas :

<code>mkdir my-rest-api
cd my-rest-api</code>

2. Tentukan CRUD Routing

get /item : Dapatkan semua projek

<code>npm init -y</code>

get /item /: id

: Dapatkan satu item dengan id

pos /item

<code>npm install express</code>

: Buat projek baru

put /item /: id

: Kemas kini projek melalui id

<code>npm install --save-dev nodemon</code>

padam /item /: id : Padam projek melalui id

<code>touch index.js</code>

Langkah 5: Uji API anda

Gunakan posman

<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>

atau uji endpoint api anda:

get https://www.php.cn/link/8a701b176cc140888936dad15d046a -Membuat semua projek.

post

1. https://www.php.cn/link/8a701b176cc140888936dad15d046a - Buat projek baru. Hantar badan utama JSON yang serupa dengan . get
https://www.php.cn/link/8a701b176cc140888936dad15d046a/1
2. Put https://www.php.cn/link/8a701b176cc140888936dad15d046a/1 {"name": "项目 1"} Projek kemas kini. Hantar badan utama JSON yang serupa dengan .
3. DELETE https://www.php.cn/link/8a701b176cc140888936dad15d046a/1 - Padam item melalui ID.
4. Langkah 6: Tambah Rawatan Ralat (Pilihan) Untuk menangani kesilapan di seluruh dunia, tambahkan middleware ini pada akhir fail index.js: {"name": "已更新的项目 1"}
5. Langkah 7: Susun kod anda (pilihan) Dengan pembangunan projek, anda boleh menyusun kod ke dalam fail dan folder yang berasingan. Contohnya: Laluan/
: Tentukan laluan.

---

Controller/

: Pemprosesan Logik Perniagaan.

Model/

: Tentukan struktur data.

<code>node index.js</code>

---

kod akhir

ini adalah fail index.js lengkap:

• Kesimpulan Tahniah! Anda telah membina API REST yang mudah dengan node.js dan Express.js. Ini hanya permulaan -anda juga boleh melakukan lebih banyak perkara, seperti mengintegrasikan pangkalan data, menambah pengesahan identiti atau menggunakan API anda ke awan.
• terus mencuba, saya doakan anda gembira!

Atas ialah kandungan terperinci Cara Membuat API REST dengan Node.js dan Express.js (untuk pemula). Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!