Cara Membuat REST API dengan Node.js dan Express

Rest API menyediakan cara terstruktur dan terukur untuk berbagai komponen perangkat lunak untuk berkomunikasi melalui Internet. Node.js, runtime JavaScript sisi server, dan Express, framework Node.js yang populer, merupakan kombinasi yang kuat untuk membuat RESTful API.

 

Dalam dunia pengembangan web, membangunAPI RESTmerupakan persyaratan umum. REST (Representational State Transfer) API menyediakan cara terstruktur dan terukur bagi berbagai komponen perangkat lunak untuk berkomunikasi melalui Internet.

Node.js, runtime JavaScript sisi server, dan Express, kerangka kerja Node.js yang populer, merupakan kombinasi yang kuat untuk membuat RESTful API. Dalam postingan blog ini, kita akan menjelajahi proses pembuatan REST API menggunakan Node.js dan Express, langkah demi langkah, dengan contoh praktis.

Prasyarat

Sebelum kita mendalami pembuatan REST API, pastikan Anda memiliki alat dan pengetahuan berikut:

1. Node.js dan npm: Instal Node.js, yang mencakup npm (Node Package Manager), darisitus web resmi.
2. Editor Teks atau IDE: Pilih editor kode pilihan Anda. Beberapa pilihan yang populer adalah Visual Studio Code, Sublime Text, atau WebStorm.
3. Pengetahuan Dasar JavaScript: Pemahaman tentang JavaScript sangat penting untuk pengembangan Node.js.

Panduan Langkah demi Langkah untuk Membangun REST API dengan Node.js

Langkah 1: Inisialisasi Proyek Anda

Mari kita mulai dengan membuat direktori baru untuk proyek Anda dan menginisialisasinya dengan npm.

mkdir my-rest-api
cd my-rest-api
npm init -y

Ini akan membuat apaket.jsonfile dengan pengaturan default untuk proyek Anda.

Langkah 2: Instal Dependensi

Kami memerlukan beberapa paket untuk mengaktifkan dan menjalankan REST API kami:

• Ekspres: Kerangka aplikasi web untuk Node.js.
• Body-parser: Middleware untuk mengurai isi permintaan masuk.
• Nodemon (Opsional): Alat yang membantu memulai ulang server secara otomatis selama pengembangan.

Instal paket-paket ini menggunakan npm:

const express = require('express');
const bodyParser = require('body-parser');
const app = express();

app.use(bodyParser.json());

const port = process.env.PORT || 3000;
app.listen(port, () => {
  console.log(`Server is running on port ${port}`);
});

Langkah 3: Buat Aplikasi Ekspres

Sekarang, mari buat aplikasi Express dan siapkan server dasar.

javascriptSalin codeconst express = require('express');const bodyParser = require('body-parser');const app = express();use(bodyParser.json());const port = process.env.PORT || 3000;listen(port, () => {console.log(`Server berjalan pada port ${port}`);

Di sini, kami telah membuat aplikasi Express dasar, menambahkan middleware body-parser untuk mengurai data JSON, dan memulai server pada port 3000.

Langkah 4: Tentukan Rute

Dalam REST API, rute menentukan titik akhir untuk metode HTTP yang berbeda (GET, POST, PUT, DELETE). Mari kita buat contoh sederhana dengan permintaan GET.

app.get('/api/hello', (req, res) => {
  res.json({ pesan: 'Halo, Dunia!' });
});

Kode ini mendefinisikan rute untuk/api/haloyang merespons dengan pesan JSON ketika diakses melalui permintaan GET.

Langkah 5: Jalankan API Anda

Anda dapat menjalankan API menggunakan Node.js, namun selama pengembangan, akan berguna jika menggunakan Nodemon, yang secara otomatis akan memulai ulang server Anda jika ada perubahan kode.

npm start

Sekarang, jika Anda mengakseshttp://localhost:3000/api/halo, Anda akan melihat pesan "Halo, Dunia!" pesan.

Langkah 6: Tambahkan Rute Lainnya

Untuk membuat API yang berguna, Anda perlu menentukan lebih banyak rute dan mengimplementasikan operasi CRUD (Buat, Baca, Perbarui, Hapus) untuk sumber daya Anda. Berikut ini contoh API "Daftar Tugas" sederhana。

let todos = [];

app.get('/api/todos', (req, res) => {
  res.json(todos);
});

app.post('/api/todos', (req, res) => {
  const newTodo = req.body;
  todos.push(newTodo);
  res.status(201).json(newTodo);
});

// Implementasikan PUT dan DELETE sebagai latihan

Dalam contoh ini, kami telah menambahkan rute ke daftar dan membuat item tugas. Anda dapat memperluasnya dengan menerapkan PUT dan DELETE untuk memperbarui dan menghapus tugas.

Langkah 7: Menguji API Anda

Menguji API Anda sangat penting untuk memastikan API berfungsi sesuai harapan. Alat sepertiTukang posatauInsomniadapat membantu Anda mengirim permintaan dan memverifikasi tanggapannya.

Langkah 8: Terapkan API Anda

When you're ready to share your API with the world, you can deploy it on platforms like Heroku, AWS,atauAzure.

Cara alternatif Membuat REST API dengan Apidog

Apidog menyederhanakan pengembangan REST API, menyederhanakan pengujian, dokumentasi, keamanan, dan kinerja. Artikel ini menunjukkan cara menggunakan Apidog dan fitur utamanya. Daftar gratis untuk meningkatkan efisiensi pengembangan API Anda.

Langkah 1: Buat akun Apidog

Pertama, Anda perlu membuat akun di Apidog. Hal ini dapat dilakukan dengan mengunjungi situs Apidog dan mengklik tombol "Daftar". Setelah registrasi, Anda akan diarahkan ke beranda Apidog.

Langkah 2: Buat API

Di dalam proyek, Anda dapat membuat API baru. Dokumentasinya adalah cetak biru REST API, yang menjelaskan sumber daya, operasi, dan parameternya. Untuk membuat API baru, klik tombol "+" di halaman proyek.

Langkah 3: Tetapkan Parameter REST API

IsiMetode HTTP, model permintaan/respons, parameter kueri, header, dll.

Langkah 4: Menguji REST API

Setelah semua API dikembangkan, Anda dapat mengklik tombol "Kirim" untuk menguji API Anda.

Kesimpulan

Membuat REST API dengan Node.js dan Express adalah keterampilan yang ampuh bagi pengembang web mana pun. Dalam postingan blog ini, kami membahas langkah-langkah penting mulai dari penyiapan proyek hingga penentuan rute, dan bahkan menyentuh pengujian dan penerapan. Ingat, latihan adalah kuncinya, jadi jangan ragu untuk membuat API Anda sendiri, bereksperimen dengan berbagai fungsi, dan menjelajahi fitur lebih lanjut saat Anda semakin mahir menggunakan Node.js dan Express.

Dengan dasar ini, Anda akan siap mengembangkan aplikasi web yang kuat dan skalabel dengan RESTful API. Selamat membuat kode!

Kembali