Comment fonctionnent les API REST · Cartes mentales

Comment fonctionnent les API REST. Une carte mentale modifiable avec des branches colorées, des idées secondaires et des liens. Les courbes montrent les liens; les flèches indiquent les relations où le sens compte.

Une API REST est une conversation en HTTP : le client envoie une requête qui nomme une ressource et une action, le serveur la traite et la réponse comporte un code d'état et le résultat.

Comment fonctionnent les API REST · Cartes mentales

Le canevas MindMap interactif de cette explication : chaque couloir, ligne et flèche ci-dessus appartient à un véritable diagramme QueryChart que vous pouvez ouvrir et modifier.

Comment lire cette carte mentale

  • Commencez par le sujet central, puis suivez une branche colorée pour explorer ses idées.
  • Les courbes montrent les liens; les flèches indiquent les relations où le sens compte.

Request

Cette branche rassemble “The method is the verb — GET reads, POST creates, PUT replaces, PATCH updates, DELETE removes. REST names resources by URL and acts on them with these verbs.”, “Client sends the request over HTTPS”.

Routing

Cette branche rassemble “The URL path is the routing key: /users/42 is the handler for one user. Query parameters, headers and the body carry everything else the handler needs.”, “Validation covers authentication (are you who you say you are?), authorization (are you allowed?), and the payload itself (is the data well formed?).”.

Business logic

Cette branche rassemble “Handler runs the business logic”, “Server reads or writes the resource in the database”.

Response

Cette branche rassemble “The status code is the contract: 200 OK, 201 Created, 204 No Content, 404 Not Found, 500 Server Error. Clients branch on it before they read the body.”, “Client receives the response and parses it”, “Client renders the result to the user”.

Errors

Cette branche rassemble “Server returns 400 / 401 / 403”.

Liens entre les branches

REST est un contrat en HTTP : les méthodes sont des verbes, les URL sont des ressources et les codes d'état sont le résultat lisible par machine.

Le client est sans état : chaque requête contient tout ce dont le serveur a besoin, aucune session partagée n'est donc requise.

La validation est la limite de sécurité ; une demande non valide est rejetée avant l'exécution de toute logique métier.

La réponse est définie par son code d'état en premier et son corps en second.

Le trafic REST utilise la même infrastructure DNS, HTTPS et Internet que la carte visuelle des autres technologies.

Relations et enseignements clés

  • REST est un contrat en HTTP : les méthodes sont des verbes, les URL sont des ressources et les codes d'état sont le résultat lisible par machine.
  • Le client est sans état : chaque requête contient tout ce dont le serveur a besoin, aucune session partagée n'est donc requise.
  • La validation est la limite de sécurité ; une demande non valide est rejetée avant l'exécution de toute logique métier.
  • La réponse est définie par son code d'état en premier et son corps en second.
  • Le trafic REST utilise la même infrastructure DNS, HTTPS et Internet que la carte visuelle des autres technologies.

Quand utiliser ce visuel

  • Enseigner la méthode HTTP/URL/modèle de statut aux ingénieurs avant qu'ils ne conçoivent leur premier point de terminaison.
  • Examiner le contrat d'une API (les codes d'état des erreurs sont-ils ou 200 avec un indicateur ?) par rapport à la convention REST.
  • Ancrer une conversation sur l'idempotence et la mise en cache dans la manière dont les demandes sont réellement créées et validées.

Comment cela fonctionne

  1. Adapter le sujet central

    Renommez le sujet pour votre projet ou votre cours.

  2. Développer les branches

    Modifiez les idées et ajoutez des exemples ou des notes.

  3. Relier les idées

    Reliez les branches; utilisez une flèche lorsque le sens est important.

Questions fréquentes

Qu'est-ce qu'une API REST ?

Une API REST est un ensemble de points de terminaison HTTP qui exposent les ressources d'un système. Les clients agissent sur les ressources avec des méthodes HTTP (GET pour lire, POST pour créer, PUT ou PATCH pour mettre à jour, DELETE pour supprimer) et le serveur répond avec un code d'état et une représentation, généralement JSON. REST est un style plutôt qu'un standard, et sa valeur est que tout client parlant HTTP peut l'utiliser.

Quelle est la différence entre GET, POST, PUT et DELETE ?

Ce sont les verbes du contrat REST. GET lit une ressource et ne devrait avoir aucun effet secondaire. POST crée une nouvelle ressource et renvoie son identité. PUT remplace en gros une ressource et est idempotent : la répéter ne change rien de plus. PATCH applique une mise à jour partielle. DELETE supprime une ressource. Ensemble, les verbes et l'URL nomment l'action complète, c'est pourquoi la zone de requête dans le visuel appelle d'abord la méthode.

Pourquoi les codes d’état sont-ils importants dans REST ?

Parce qu’ils constituent le résultat lisible par machine de la demande. Un client peut bifurquer sur le code d'état sans analyser le corps : 2xx succès, 4xx erreur du client, 5xx celle du serveur. Les API qui renvoient 200 avec un indicateur d'erreur dans le corps rompent ce contrat et obligent chaque client à utiliser une casse particulière pour la réponse.

Qu'est-ce qui rend une API « RESTful » ?

La liste de contrôle pratique : des ressources nommées par URL, des actions exprimées sous forme de méthodes HTTP, des requêtes sans état (chacune transporte tout ce dont le serveur a besoin), des réponses qui utilisent correctement les codes d'état et souvent des URL hypermédia ou versionnées. Le canevas modélise l'aller-retour (demande, validation, traitement, réponse) qui est la forme partagée par chaque échange RESTful.

Modifier cette carte mentale dans QueryChart

Ouvrez cette carte mentale sur un espace modifiable. Déplacez les idées et ajoutez des branches et des liens.

Modifier cette carte mentale dans QueryChart

Plus dans Cartes mentales