Node.js Backend Development Bootcamp · Leçon

Concevoir des points d’accès d’API RESTful

Apprenez les principes fondamentaux de REST et concevez des points d’accès d’API clairs et efficaces pour diverses ressources.

Concevoir des points d’accès d’API RESTful est une leçon Node.js Backend Development Bootcamp gratuite sur CoddyKit. Ceci est la leçon 3 sur 4. Tu peux lire la leçon complète ci-dessous gratuitement — puis la pratiquer en direct dans le navigateur avec un éditeur de code intégré et un tuteur IA 24/7. Elle fait partie du parcours d'apprentissage Node.js Backend Development Bootcamp, et ta progression se synchronise sur le web et l'application CoddyKit. Le cours Node.js Backend Development Bootcamp comprend 4 leçons au total.

Certaines parties de cette leçon n'ont pas encore été traduites et s'affichent en anglais.

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!

Questions Fréquemment Posées

La leçon « Concevoir des points d’accès d’API RESTful » est-elle gratuite ?

Oui — le texte complet de « Concevoir des points d’accès d’API RESTful » est gratuit à lire ici sur le web. Pour la pratiquer de manière interactive (un éditeur de code intégré et un tuteur IA 24/7) et déverrouiller le reste du cours Node.js Backend Development Bootcamp, passe à CoddyKit PRO. Le cours Node.js Backend Development Bootcamp comprend 4 leçons au total.

Qu'est-ce que j'apprendrai dans « Concevoir des points d’accès d’API RESTful » ?

Apprenez les principes fondamentaux de REST et concevez des points d’accès d’API clairs et efficaces pour diverses ressources. Tu pratiques Node.js Backend Development Bootcamp avec du code pratique que tu exécutes directement dans le navigateur, et un tuteur IA 24/7 répond à tes questions au fur et à mesure que tu avances dans la leçon.

Dois-je avoir de l'expérience pour commencer Node.js Backend Development Bootcamp ?

Aucune expérience préalable n'est requise. Node.js Backend Development Bootcamp sur CoddyKit est structuré pour les débutants jusqu'aux apprenants avancés, donc tu peux commencer ici ou depuis le début et avancer à ton rythme. Ceci est la leçon 3 sur 4.

Combien de temps prend la leçon « Concevoir des points d’accès d’API RESTful » ?

La plupart des leçons CoddyKit prennent environ 5–10 minutes. Chacune est courte et interactive, tu progresses régulièrement et tu repiques exactement où tu t'es arrêté sur le web et l'app.

Peux-tu écrire et exécuter du code dans cette leçon Node.js Backend Development Bootcamp ?

Oui. Chaque leçon Node.js Backend Development Bootcamp inclut un éditeur de code intégré, tu écris et exécutes du vrai code directement dans ton navigateur et tu reçois des retours IA instantanés — aucune configuration locale requise.

Toutes les leçons de ce cours

Fondamentaux du framework Express.js
Routage et intergiciels dans Express
Concevoir des points d’accès d’API RESTful
Gérer les données des requêtes : corps, requête et paramètres

← Retour à Node.js Backend Development Bootcamp