Panduan Pemula untuk Menstrukturkan API dalam Node.js: Bersih & Boleh Skala

Panduan Bermula untuk Seni Bina API REST Node.js

Panduan ini akan membantu anda mempelajari cara membina API REST Node.js yang berstruktur dengan jelas. Termasuk organisasi folder, amalan terbaik dan petua untuk membina API boleh skala dan boleh diselenggara.

---

Jadual Kandungan

• Panduan Bermula untuk Seni Bina API REST Node.js
  • Jadual Kandungan
  • Pengenalan kepada seni bina API Node.js
  • Mengapa seni bina API penting?
  • Konsep teras seni bina API
  • Struktur folder API asas
  • Arahan langkah demi langkah
    • 1. server.js
    • 2. Pembolehubah persekitaran (.env)
    • 3. Penghalaan
    • 4. Pengawal
    • 5. Model
    • 6. Tatarajah
  • Amalan Terbaik
  • Kes sebenar
  • Ringkasan
  • Kesimpulan dan maklum balas?
  • Kekal berhubung ?

Pengenalan kepada seni bina API Node.js

API ialah asas aplikasi web moden, menghubungkan bahagian hadapan dan pelayan. Walau bagaimanapun, API yang tidak berstruktur boleh membawa kepada kod yang berselerak dan sukar untuk diselenggara. Bagi mereka yang baru menggunakan Node.js, memahami cara mengatur projek dari awal adalah penting untuk membina aplikasi yang berskala dan bersih.

Panduan ini akan membimbing anda melalui seni bina asas API REST Node.js. Kami akan merangkumi perkara penting, amalan terbaik dan menyediakan struktur folder praktikal yang boleh anda gunakan untuk projek anda. Baca lebih lanjut tentang struktur folder

---

Mengapa seni bina API penting?

Apabila bermula, ramai pembangun meletakkan semuanya ke dalam satu fail. Walaupun ini berfungsi untuk projek kecil, apabila asas kod berkembang ia boleh menjadi mimpi ngeri. Struktur API yang baik membantu:

• Kebolehselenggaraan: Menjadikan ia lebih mudah untuk mencari dan mengubah suai kod.
• Skalabiliti: Membenarkan aplikasi anda berkembang tanpa gangguan.
• Kerjasama: Bantu pasukan memahami kod dengan cepat.
• Kebolehbacaan: Kod kosong lebih mudah untuk nyahpepijat dan dilanjutkan.

---

Konsep teras seni bina API

Sebelum kita menyelami struktur folder, mari kita fahami beberapa prinsip asas:

1. Pemisahan Kebimbangan: Simpan bahagian aplikasi yang berlainan (cth. penghalaan, pangkalan data, logik) dalam fail berasingan untuk mengelakkan kekeliruan tanggungjawab.
2. Pemodularan: Pecah kod kepada modul boleh guna semula.
3. Pembolehubah Persekitaran: Gunakan fail .env untuk menyimpan data sensitif seperti bukti kelayakan pangkalan data dengan selamat.

---

Struktur folder API asas

Ini ialah struktur ringkas untuk projek kecil, sesuai untuk pemula mutlak:

<code>my-api/
├── server.js          # 入口点
├── package.json       # 项目元数据和依赖项
├── .env               # 环境变量
├── /routes            # API 路由定义
│   └── userRoutes.js  # 示例：用户相关的路由
├── /controllers       # 请求处理逻辑
│   └── userController.js
├── /models            # 数据库模型或模式
│   └── userModel.js
└── /config            # 配置文件
    └── db.js          # 数据库连接设置</code>

---

Arahan langkah demi langkah

1. pelayan.js

Titik masuk ke aplikasi:

• Sediakan pelayan Express.
• Muat perisian tengah dan laluan.

<code>my-api/
├── server.js          # 入口点
├── package.json       # 项目元数据和依赖项
├── .env               # 环境变量
├── /routes            # API 路由定义
│   └── userRoutes.js  # 示例：用户相关的路由
├── /controllers       # 请求处理逻辑
│   └── userController.js
├── /models            # 数据库模型或模式
│   └── userModel.js
└── /config            # 配置文件
    └── db.js          # 数据库连接设置</code>

---

2. Pembolehubah persekitaran (.env)

Gunakan fail .env untuk menyimpan data sensitif:

<code class="language-javascript">require('dotenv').config();
const express = require('express');
const userRoutes = require('./routes/userRoutes');
const connectDB = require('./config/db');

const app = express();
const PORT = process.env.PORT || 5000;

// 中间件
app.use(express.json());

// 数据库连接
connectDB();

// 路由
app.use('/api/users', userRoutes);

app.listen(PORT, () => console.log(`服务器运行在端口 ${PORT}`));</code>

Pasang dotenv untuk memuatkan pembolehubah ini ke dalam process.env:

<code>PORT=5000
MONGO_URI=mongodb+srv://username:password@cluster.mongodb.net/myDatabase</code>

---

3

Laluan mengendalikan permintaan HTTP dan mengarahkannya kepada pengawal yang sesuai.

/routes/userRoutes.js:

<code class="language-bash">npm install dotenv</code>

---

4

Pengawal mengandungi logik untuk mengendalikan permintaan.

/controllers/userController.js:

<code class="language-javascript">const express = require('express');
const { getAllUsers, createUser } = require('../controllers/userController');
const router = express.Router();

// 获取所有用户
router.get('/', getAllUsers);

// POST 创建新用户
router.post('/', createUser);

module.exports = router;</code>

5

---

Model mentakrifkan struktur dokumen pangkalan data. Dalam contoh ini, kami menggunakan MongoDB dan Mongoose.

/models/userModel.js:

6

<code class="language-javascript">const User = require('../models/userModel');

// 获取所有用户
const getAllUsers = async (req, res) => {
  try {
    const users = await User.find();
    res.status(200).json(users);
  } catch (error) {
    res.status(500).json({ message: error.message });
  }
};

// POST 创建新用户
const createUser = async (req, res) => {
  try {
    const { name, email } = req.body;
    const newUser = await User.create({ name, email });
    res.status(201).json(newUser);
  } catch (error) {
    res.status(500).json({ message: error.message });
  }
};

module.exports = { getAllUsers, createUser };</code>

Folder konfigurasi mengandungi fail yang bersambung ke sumber luaran seperti pangkalan data.

---

/config/db.js:

Amalan Terbaik

<code class="language-javascript">const mongoose = require('mongoose');

const userSchema = new mongoose.Schema({
  name: { type: String, required: true },
  email: { type: String, required: true, unique: true }
});

module.exports = mongoose.model('User', userSchema);</code>

---

Pastikan kod anda KERING (jangan ulangi sendiri)

: Elakkan penduaan logik dan modul apabila boleh.

1. Pengendalian Ralat: Sentiasa gunakan blok cuba-tangkap atau perisian tengah untuk mengendalikan ralat dengan anggun.
2. Gunakan perisian tengah: Untuk tugasan seperti pengesahan, permintaan pengesahan dan pengelogan.
3. Versi API: Gunakan versi (/api/v1/users) untuk mengendalikan kemas kini masa hadapan tanpa memecahkan pelanggan lama.
4. Kes sebenar

Berikut ialah beberapa idea latihan:

---

API Blog (Pengguna, Catatan dan Komen).

API Pengurus Tugas (Tugas, Pengguna dan Tarikh Akhir).

• Ringkasan

Bermula dengan API yang bersih dan berstruktur ialah asas kepada projek yang boleh diselenggara. Dengan memisahkan kebimbangan dan menyusun kod anda secara logik, anda akan menyediakan permohonan anda untuk pertumbuhan.

---

Ingat, ini hanyalah titik permulaan! Apabila pengalaman anda berkembang, anda boleh menyesuaikan dan mengembangkan struktur ini untuk menampung projek yang lebih besar dan lebih kompleks.

Adakah anda mempunyai sebarang cabaran atau idea khusus yang anda ingin kami terokai dalam artikel akan datang? Beritahu kami dalam ulasan!

Kesimpulan dan maklum balas?

Terima kasih kerana meluangkan masa untuk membaca ini! Saya harap ia membantu anda memudahkan topik dan memberikan pandangan yang berharga. Jika anda mendapati ia berguna, ikuti saya untuk kandungan yang lebih mudah dihadam tentang pembangunan web dan topik teknikal lain.

---

Maklum balas anda adalah penting! Sila kongsi pendapat anda di bahagian komen - sama ada cadangan, soalan atau sesuatu yang anda ingin saya perbaiki. Jangan ragu untuk menggunakan emoji untuk memberitahu saya apa yang anda rasakan oleh siaran ini. ?

Kekal berhubung ?

Saya ingin berhubung dengan anda! Mari kita terus bertukar idea, belajar antara satu sama lain, dan berkembang bersama.

---

Ikuti saya di media sosial dan mari kekal berhubung:

Twitter

LinkedIn

Tidak sabar untuk mendengar daripada anda dan mengembangkan komuniti orang yang ingin tahu ini! ?

Atas ialah kandungan terperinci Panduan Pemula untuk Menstrukturkan API dalam Node.js: Bersih & Boleh Skala. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!