Rumah > hujung hadapan web > tutorial js > Panduan Pemula untuk Membina API dengan Express.js

Panduan Pemula untuk Membina API dengan Express.js

Patricia Arquette
Lepaskan: 2024-12-01 08:17:15
asal
488 orang telah melayarinya

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

API (Antara Muka Pengaturcaraan Aplikasi) ialah tulang belakang aplikasi web moden, yang membolehkan komunikasi antara bahagian hadapan dan bahagian belakang. Salah satu alatan yang paling popular untuk membina API dalam JavaScript ialah Express.js, rangka kerja Node.js yang minimalis dan fleksibel. Panduan ini akan membimbing anda melalui asas membina API dengan Express.js.

Apakah Express.js?
Express.js ialah rangka kerja ringan untuk membina aplikasi sisi pelayan dengan Node.js. Ia memudahkan tugas seperti mengendalikan permintaan HTTP, penghalaan dan penyepaduan perisian tengah, menjadikannya pilihan terbaik untuk mencipta API.

Mengapa Gunakan Express.js?

  • Kemudahan Penggunaan: Sintaks mudah dan persediaan pantas.
  • Fleksibiliti: Boleh disesuaikan dengan perisian tengah untuk menambah ciri seperti pengesahan, pengelogan dan pengendalian ralat.
  • Skalabiliti: Sesuai untuk kedua-dua aplikasi kecil dan besar.

Menyediakan Persekitaran Express.js Anda

Langkah 1: Pasang Node.js
Pastikan anda telah memasang Node.js. Muat turunnya daripada nodejs.org jika perlu.

Langkah 2: Mulakan Projek Anda
Buat direktori projek baharu dan mulakan ia:

mkdir express-api  
cd express-api  
npm init -y 
Salin selepas log masuk
Salin selepas log masuk

Ini mencipta fail package.json untuk mengurus kebergantungan.

Langkah 3: Pasang Express.js
Pasang Express.js menggunakan npm:

npm install express  
Salin selepas log masuk
Salin selepas log masuk

Membina API Pertama Anda

Langkah 1: Buat Pelayan Asas
Mulakan dengan mencipta fail server.js dan menambah kod berikut:

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

app.listen(PORT, () => {  
  console.log(`Server is running on http://localhost:${PORT}`);  
});  
Salin selepas log masuk
Salin selepas log masuk

Jalankan pelayan dengan:

node server.js 
Salin selepas log masuk

Lawati http://localhost:3000, dan anda akan melihat pelayan sedang berjalan (walaupun ia tidak akan mengembalikan apa-apa lagi).

Langkah 2: Tentukan Laluan Pertama Anda
Laluan menentukan cara API anda bertindak balas terhadap permintaan pelanggan. Tambahkan laluan mudah untuk mengembalikan mesej alu-aluan:

app.get('/', (req, res) => {  
  res.send('Welcome to your first Express API!');  
});  
Salin selepas log masuk

Mulakan semula pelayan anda dan melawati http://localhost:3000 kini akan memaparkan mesej.

Langkah 3: Buat Titik Akhir API
Mari tambahkan titik akhir untuk mengendalikan data. Contohnya, laluan /users yang mengembalikan senarai pengguna:

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

app.get('/users', (req, res) => {  
  res.json(users);  
}); 
Salin selepas log masuk

Melawati http://localhost:3000/users kini akan mengembalikan data pengguna dalam format JSON.

Menambah Middleware
Fungsi middleware dalam permintaan dan respons proses Express.js. Contohnya, anda boleh menggunakan perisian tengah untuk menghuraikan data JSON yang dihantar oleh pelanggan.

Langkah 1: Gunakan Perisian Tengah Terbina dalam
Untuk mendayakan penghuraian JSON, tambahkan yang berikut:

app.use(express.json());  
Salin selepas log masuk

Langkah 2: Kendalikan Permintaan POST
Tambahkan laluan untuk mencipta pengguna baharu:

mkdir express-api  
cd express-api  
npm init -y 
Salin selepas log masuk
Salin selepas log masuk

Kini anda boleh menghantar permintaan POST dengan data JSON ke http://localhost:3000/users untuk menambah pengguna baharu.

Pengendalian Ralat
Untuk mengendalikan ralat dengan anggun, gunakan perisian tengah. Contohnya:

npm install express  
Salin selepas log masuk
Salin selepas log masuk

Ini memastikan sebarang ralat yang tidak dikendalikan mengembalikan respons yang bermakna.

Kod Akhir
Berikut ialah contoh lengkapnya:

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

app.listen(PORT, () => {  
  console.log(`Server is running on http://localhost:${PORT}`);  
});  
Salin selepas log masuk
Salin selepas log masuk

Kesimpulan
Express.js menjadikan membina API mudah dan cekap, menawarkan alatan dan fleksibiliti yang anda perlukan untuk bermula dengan cepat. Dengan memahami asas menyediakan laluan, mengendalikan data dan menggunakan perisian tengah, anda boleh mencipta API yang berkuasa untuk aplikasi web anda.

Teruskan meneroka ciri seperti pengesahan, penyepaduan pangkalan data dan pengendalian ralat lanjutan untuk membawa API anda ke peringkat seterusnya!

Atas ialah kandungan terperinci Panduan Pemula untuk Membina API dengan Express.js. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!

sumber:dev.to
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
Artikel terbaru oleh pengarang
Tutorial Popular
Lagi>
Muat turun terkini
Lagi>
kesan web
Kod sumber laman web
Bahan laman web
Templat hujung hadapan