0Pricing
Node.js Backend Development Bootcamp · Pelajaran

Merancang Titik Akhir API Bergaya REST

Pelajari prinsip inti REST dan rancang titik akhir API yang bersih serta efisien untuk berbagai sumber daya.

Merancang Titik Akhir API Bergaya REST adalah pelajaran Node.js Backend Development Bootcamp gratis di CoddyKit. Ini adalah pelajaran 3 dari 4. Kamu bisa membaca pelajaran lengkapnya di bawah secara gratis — lalu praktikkan langsung di browser dengan editor kode bawaan dan tutor AI 24/7. Ini adalah bagian dari jalur belajar Node.js Backend Development Bootcamp, dan progresmu tersinkronisasi di web dan aplikasi CoddyKit. Kursus Node.js Backend Development Bootcamp mencakup 4 pelajaran total.

Bagian dari pelajaran ini belum diterjemahkan dan ditampilkan dalam bahasa Inggris.

Intro to RESTful APIs

Welcome! In this lesson, we'll dive into designing clean and efficient API endpoints following REST principles. Understanding REST is crucial for building scalable web services.

REST stands for Representational State Transfer. It's an architectural style for networked applications, emphasizing a stateless client-server communication.

Resources: The Nouns of REST

At the heart of REST are resources. Think of resources as any information or data that your API can provide or manipulate. They are the 'things' your API manages.

  • A resource is identified by a unique URL (Uniform Resource Locator).
  • They are typically represented by nouns, like users, products, or orders.
  • Ideally, use plural nouns for collections of resources.

Actions with HTTP Methods

While resources are nouns, the actions you perform on them are indicated by standard HTTP methods (also called verbs). These methods correspond directly to common data operations:

  • GET: Retrieve data (Read)
  • POST: Create new data (Create)
  • PUT: Replace existing data (Update all)
  • PATCH: Partially update existing data (Update partial)
  • DELETE: Remove data (Delete)

Structuring Your API Endpoints

A well-designed endpoint URL should be intuitive and predictable. It typically follows a pattern:

/api/<version>/<resource_name>

Using a version (like v1) is good practice for future API changes. Always use plural nouns for resource names.

  • Good: /api/v1/users
  • Bad: /api/v1/getUsers

Collection and Item URLs

REST APIs distinguish between a collection of resources and a single resource within that collection:

  • Collection URL: Refers to a group of resources. E.g., /users (all users).
  • Item URL: Refers to a specific resource. E.g., /users/123 (user with ID 123).

The ID (:id in Express) is a unique identifier for that specific resource.

Speaking with Status Codes

HTTP status codes are crucial for your API to communicate the outcome of a request to the client. They tell the client if the request was successful, if there was an error, and why.

  • 200 OK: Request successful.
  • 201 Created: Resource successfully created.
  • 204 No Content: Request successful, but no content to return (e.g., DELETE).
  • 400 Bad Request: Client sent invalid data.
  • 404 Not Found: Resource not found.
  • 500 Internal Server Error: Server-side error.

User API Endpoint Design

Let's design endpoints for a User resource. Notice how HTTP methods and URLs combine to describe actions.

Try running this example to see the routes in action:

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

// Get all users
app.get('/api/v1/users', (req, res) => {
  res.status(200).send('GET /api/v1/users: Retrieve all users');
});

// Create a new user
app.post('/api/v1/users', (req, res) => {
  res.status(201).send('POST /api/v1/users: Create a new user');
});

// Get a specific user by ID
app.get('/api/v1/users/:id', (req, res) => {
  res.status(200).send(`GET /api/v1/users/${req.params.id}: Retrieve user ${req.params.id}`);
});

// Update a specific user by ID
app.put('/api/v1/users/:id', (req, res) => {
  res.status(200).send(`PUT /api/v1/users/${req.params.id}: Update user ${req.params.id}`);
});

// Delete a specific user by ID
app.delete('/api/v1/users/:id', (req, res) => {
  res.status(204).send(`DELETE /api/v1/users/${req.params.id}: Delete user ${req.params.id}`);
});

app.listen(port, () => {
  console.log(`User API running on http://localhost:${port}`);
});

Product API Endpoint Design

Here's another example for a Product resource. The patterns remain consistent, making your API easy to understand and use for developers.

Run this code to see a product-focused API:

const express = require('express');
const app = express();
const port = 3001; // Using a different port

// Get all products
app.get('/api/v1/products', (req, res) => {
  res.status(200).send('GET /api/v1/products: Retrieve all products');
});

// Create a new product
app.post('/api/v1/products', (req, res) => {
  res.status(201).send('POST /api/v1/products: Create a new product');
});

// Get a specific product by ID
app.get('/api/v1/products/:id', (req, res) => {
  res.status(200).send(`GET /api/v1/products/${req.params.id}: Retrieve product ${req.params.id}`);
});

// Delete a specific product by ID
app.delete('/api/v1/products/:id', (req, res) => {
  res.status(204).send(`DELETE /api/v1/products/${req.params.id}: Delete product ${req.params.id}`);
});

app.listen(port, () => {
  console.log(`Product API running on http://localhost:${port}`);
});

Clean URL Best Practices

To ensure your API is user-friendly and maintainable, follow these best practices:

  • Use Plural Nouns: For collections (e.g., /products, not /product).
  • Avoid Verbs in URLs: Let HTTP methods define actions (e.g., POST /users, not /createUser).
  • Use Hyphens: For readability in multi-word resource names (e.g., /order-items).
  • Keep URLs Simple: Avoid deep nesting; query parameters can handle filtering/sorting.

Test Your REST Knowledge

Which of the following endpoint designs correctly follows RESTful principles for creating a new product and retrieving a specific product?

Recap: Designing RESTful Endpoints

Great job! You've learned the fundamentals of designing RESTful API endpoints. Remember these key takeaways:

  • Resources are the nouns, identified by URLs.
  • HTTP Methods (GET, POST, PUT, DELETE) define actions.
  • Use plural nouns for collections and specific IDs for items.
  • Communicate outcomes using appropriate HTTP Status Codes.
  • Strive for clean, predictable URLs for a user-friendly API.

This foundation will help you build robust and intuitive APIs!

Pertanyaan yang Sering Diajukan

Apakah pelajaran “Merancang Titik Akhir API Bergaya REST” gratis?

Ya — teks lengkap “Merancang Titik Akhir API Bergaya REST” gratis dibaca di sini di web. Untuk praktiknya secara interaktif (editor kode bawaan dan tutor AI 24/7) dan buka sisa kursus Node.js Backend Development Bootcamp, upgrade ke CoddyKit PRO. Kursus Node.js Backend Development Bootcamp mencakup 4 pelajaran total.

Apa yang akan aku pelajari di “Merancang Titik Akhir API Bergaya REST”?

Pelajari prinsip inti REST dan rancang titik akhir API yang bersih serta efisien untuk berbagai sumber daya. Kamu berlatih Node.js Backend Development Bootcamp dengan kode praktik yang langsung kamu jalankan di browser, dan tutor AI 24/7 menjawab pertanyaanmu saat kamu mengerjakan pelajaran ini.

Apakah aku perlu pengalaman untuk memulai Node.js Backend Development Bootcamp?

Tidak diperlukan pengalaman sebelumnya. Node.js Backend Development Bootcamp di CoddyKit dirancang untuk pemula hingga pelajar tingkat lanjut, jadi kamu bisa memulai di sini atau dari awal dan belajar sesuai kecepatan kamu sendiri. Ini adalah pelajaran 3 dari 4.

Berapa lama pelajaran “Merancang Titik Akhir API Bergaya REST” memakan waktu?

Sebagian besar pelajaran CoddyKit memakan waktu sekitar 5–10 menit. Setiap pelajaran ringkas dan interaktif, jadi kamu membuat kemajuan stabil dan melanjutkan dari tempat kamu tinggalkan di web dan aplikasi.

Bisakah aku menulis dan menjalankan kode dalam pelajaran Node.js Backend Development Bootcamp ini?

Ya. Setiap pelajaran Node.js Backend Development Bootcamp menyertakan editor kode bawaan, jadi kamu menulis dan menjalankan kode nyata langsung di browser dan mendapatkan umpan balik AI instan — tidak diperlukan penyiapan lokal.

Semua pelajaran dalam kursus ini

  1. Dasar-Dasar Kerangka Kerja Express.js
  2. Perutean & Middleware dalam Express
  3. Merancang Titik Akhir API Bergaya REST
  4. Menangani Data Permintaan: Body, Query & Parameter
← Kembali ke Node.js Backend Development Bootcamp