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. pelayan.js
2. Pembolehubah persekitaran (.env)
Pengawal mengandungi logik untuk mengendalikan permintaan.
Pastikan kod anda KERING (jangan ulangi sendiri)
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.
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. ?
Rumah hujung hadapan web tutorial js Panduan Pemula untuk Menstrukturkan API dalam Node.js: Bersih & Boleh Skala

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

Jan 23, 2025 pm 10:32 PM

Beginner

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
        1. Pembolehubah persekitaran (.env)
        1. Penghalaan
        1. Pengawal
        1. Model
        1. 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>
Salin selepas log masuk
Salin selepas log masuk

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>
Salin selepas log masuk
Salin selepas log masuk

2. Pembolehubah persekitaran (.env)

Gunakan fail .env untuk menyimpan data sensitif:

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}`));
Salin selepas log masuk

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

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

3

Laluan mengendalikan permintaan HTTP dan mengarahkannya kepada pengawal yang sesuai.

/routes/userRoutes.js:

npm install dotenv
Salin selepas log masuk

4

Pengawal mengandungi logik untuk mengendalikan permintaan.

/controllers/userController.js:

const express = require('express');
const { getAllUsers, createUser } = require('../controllers/userController');
const router = express.Router();

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

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

module.exports = router;
Salin selepas log masuk
5
Model mentakrifkan struktur dokumen pangkalan data. Dalam contoh ini, kami menggunakan MongoDB dan Mongoose.

/models/userModel.js:

6
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 };
Salin selepas log masuk
Folder konfigurasi mengandungi fail yang bersambung ke sumber luaran seperti pangkalan data.

/config/db.js:

Amalan Terbaik

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);
Salin selepas log masuk

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!

Kenyataan Laman Web ini
Kandungan artikel ini disumbangkan secara sukarela oleh netizen, dan hak cipta adalah milik pengarang asal. Laman web ini tidak memikul tanggungjawab undang-undang yang sepadan. Jika anda menemui sebarang kandungan yang disyaki plagiarisme atau pelanggaran, sila hubungi admin@php.cn

Alat AI Hot

Undresser.AI Undress

Undresser.AI Undress

Apl berkuasa AI untuk mencipta foto bogel yang realistik

AI Clothes Remover

AI Clothes Remover

Alat AI dalam talian untuk mengeluarkan pakaian daripada foto.

Undress AI Tool

Undress AI Tool

Gambar buka pakaian secara percuma

Clothoff.io

Clothoff.io

Penyingkiran pakaian AI

Video Face Swap

Video Face Swap

Tukar muka dalam mana-mana video dengan mudah menggunakan alat tukar muka AI percuma kami!

Artikel Panas

<🎜>: Bubble Gum Simulator Infinity - Cara Mendapatkan dan Menggunakan Kekunci Diraja
4 minggu yang lalu By 尊渡假赌尊渡假赌尊渡假赌
Nordhold: Sistem Fusion, dijelaskan
4 minggu yang lalu By 尊渡假赌尊渡假赌尊渡假赌
Mandragora: Whispers of the Witch Tree - Cara Membuka Kunci Cangkuk Bergelut
3 minggu yang lalu By 尊渡假赌尊渡假赌尊渡假赌

Alat panas

Notepad++7.3.1

Notepad++7.3.1

Editor kod yang mudah digunakan dan percuma

SublimeText3 versi Cina

SublimeText3 versi Cina

Versi Cina, sangat mudah digunakan

Hantar Studio 13.0.1

Hantar Studio 13.0.1

Persekitaran pembangunan bersepadu PHP yang berkuasa

Dreamweaver CS6

Dreamweaver CS6

Alat pembangunan web visual

SublimeText3 versi Mac

SublimeText3 versi Mac

Perisian penyuntingan kod peringkat Tuhan (SublimeText3)

Topik panas

Tutorial Java
1671
14
Tutorial PHP
1276
29
Tutorial C#
1256
24
Python vs JavaScript: Keluk Pembelajaran dan Kemudahan Penggunaan Python vs JavaScript: Keluk Pembelajaran dan Kemudahan Penggunaan Apr 16, 2025 am 12:12 AM

Python lebih sesuai untuk pemula, dengan lengkung pembelajaran yang lancar dan sintaks ringkas; JavaScript sesuai untuk pembangunan front-end, dengan lengkung pembelajaran yang curam dan sintaks yang fleksibel. 1. Sintaks Python adalah intuitif dan sesuai untuk sains data dan pembangunan back-end. 2. JavaScript adalah fleksibel dan digunakan secara meluas dalam pengaturcaraan depan dan pelayan.

Dari C/C ke JavaScript: Bagaimana semuanya berfungsi Dari C/C ke JavaScript: Bagaimana semuanya berfungsi Apr 14, 2025 am 12:05 AM

Peralihan dari C/C ke JavaScript memerlukan menyesuaikan diri dengan menaip dinamik, pengumpulan sampah dan pengaturcaraan asynchronous. 1) C/C adalah bahasa yang ditaip secara statik yang memerlukan pengurusan memori manual, manakala JavaScript ditaip secara dinamik dan pengumpulan sampah diproses secara automatik. 2) C/C perlu dikumpulkan ke dalam kod mesin, manakala JavaScript adalah bahasa yang ditafsirkan. 3) JavaScript memperkenalkan konsep seperti penutupan, rantaian prototaip dan janji, yang meningkatkan keupayaan pengaturcaraan fleksibiliti dan asynchronous.

JavaScript dan Web: Fungsi teras dan kes penggunaan JavaScript dan Web: Fungsi teras dan kes penggunaan Apr 18, 2025 am 12:19 AM

Penggunaan utama JavaScript dalam pembangunan web termasuk interaksi klien, pengesahan bentuk dan komunikasi tak segerak. 1) kemas kini kandungan dinamik dan interaksi pengguna melalui operasi DOM; 2) pengesahan pelanggan dijalankan sebelum pengguna mengemukakan data untuk meningkatkan pengalaman pengguna; 3) Komunikasi yang tidak bersesuaian dengan pelayan dicapai melalui teknologi Ajax.

JavaScript in Action: Contoh dan projek dunia nyata JavaScript in Action: Contoh dan projek dunia nyata Apr 19, 2025 am 12:13 AM

Aplikasi JavaScript di dunia nyata termasuk pembangunan depan dan back-end. 1) Memaparkan aplikasi front-end dengan membina aplikasi senarai TODO, yang melibatkan operasi DOM dan pemprosesan acara. 2) Membina Restfulapi melalui Node.js dan menyatakan untuk menunjukkan aplikasi back-end.

Memahami Enjin JavaScript: Butiran Pelaksanaan Memahami Enjin JavaScript: Butiran Pelaksanaan Apr 17, 2025 am 12:05 AM

Memahami bagaimana enjin JavaScript berfungsi secara dalaman adalah penting kepada pemaju kerana ia membantu menulis kod yang lebih cekap dan memahami kesesakan prestasi dan strategi pengoptimuman. 1) aliran kerja enjin termasuk tiga peringkat: parsing, penyusun dan pelaksanaan; 2) Semasa proses pelaksanaan, enjin akan melakukan pengoptimuman dinamik, seperti cache dalam talian dan kelas tersembunyi; 3) Amalan terbaik termasuk mengelakkan pembolehubah global, mengoptimumkan gelung, menggunakan const dan membiarkan, dan mengelakkan penggunaan penutupan yang berlebihan.

Python vs JavaScript: Komuniti, Perpustakaan, dan Sumber Python vs JavaScript: Komuniti, Perpustakaan, dan Sumber Apr 15, 2025 am 12:16 AM

Python dan JavaScript mempunyai kelebihan dan kekurangan mereka sendiri dari segi komuniti, perpustakaan dan sumber. 1) Komuniti Python mesra dan sesuai untuk pemula, tetapi sumber pembangunan depan tidak kaya dengan JavaScript. 2) Python berkuasa dalam bidang sains data dan perpustakaan pembelajaran mesin, sementara JavaScript lebih baik dalam perpustakaan pembangunan dan kerangka pembangunan depan. 3) Kedua -duanya mempunyai sumber pembelajaran yang kaya, tetapi Python sesuai untuk memulakan dengan dokumen rasmi, sementara JavaScript lebih baik dengan MDNWebDocs. Pilihan harus berdasarkan keperluan projek dan kepentingan peribadi.

Python vs JavaScript: Persekitaran dan Alat Pembangunan Python vs JavaScript: Persekitaran dan Alat Pembangunan Apr 26, 2025 am 12:09 AM

Kedua -dua pilihan Python dan JavaScript dalam persekitaran pembangunan adalah penting. 1) Persekitaran pembangunan Python termasuk Pycharm, Jupyternotebook dan Anaconda, yang sesuai untuk sains data dan prototaip cepat. 2) Persekitaran pembangunan JavaScript termasuk node.js, vscode dan webpack, yang sesuai untuk pembangunan front-end dan back-end. Memilih alat yang betul mengikut keperluan projek dapat meningkatkan kecekapan pembangunan dan kadar kejayaan projek.

Peranan C/C dalam JavaScript Jurubah dan Penyusun Peranan C/C dalam JavaScript Jurubah dan Penyusun Apr 20, 2025 am 12:01 AM

C dan C memainkan peranan penting dalam enjin JavaScript, terutamanya digunakan untuk melaksanakan jurubahasa dan penyusun JIT. 1) C digunakan untuk menghuraikan kod sumber JavaScript dan menghasilkan pokok sintaks abstrak. 2) C bertanggungjawab untuk menjana dan melaksanakan bytecode. 3) C melaksanakan pengkompil JIT, mengoptimumkan dan menyusun kod hot-spot semasa runtime, dan dengan ketara meningkatkan kecekapan pelaksanaan JavaScript.

See all articles