Tutoriel : Les méthodes HTTP d'une API REST

Les méthodes HTTP (Hypertext Transfer Protocol) sont utilisées dans les API REST (Representational State Transfer) pour indiquer l'action à réaliser sur une ressource spécifique. Voici quelques exemples de méthodes HTTP couramment utilisées dans les API REST :

GET: utilisée pour récupérer une ressource.
POST: utilisée pour créer une ressource.
PUT: utilisée pour mettre à jour une ressource existante.
DELETE: utilisée pour supprimer une ressource.
PATCH: utilisée pour mettre à jour partiellement une ressource existante.

Il existe d'autres méthodes HTTP, comme HEAD et OPTIONS, qui sont moins couramment utilisées dans les API REST.

Il est important de noter que les API REST sont basées sur l'architecture client-serveur et que les méthodes HTTP sont utilisées pour indiquer l'action à réaliser sur une ressource spécifique. Par exemple, si vous souhaitez récupérer les détails d'un utilisateur spécifique à partir d'une API REST, vous pouvez utiliser la méthode GET et envoyer une demande à l'URL de l'API qui correspond à la ressource que vous souhaitez récupérer (par exemple, /api/users/123). Le serveur traitera alors cette demande en récupérant les détails de l'utilisateur spécifique de sa base de données et en renvoyant une réponse au client.

Exemple d'utilisation

Voici un exemple d'utilisation de la méthode HTTP PUT dans une API REST pour mettre à jour une ressource existante :

Supposons que nous disposons d'une API REST qui gère les utilisateurs et que nous souhaitons mettre à jour les informations de l'utilisateur avec l'ID 123. Nous pouvons envoyer une demande HTTP PUT à l'URL suivante : /api/users/123

Voici comment cette demande pourrait être envoyée en utilisant le logiciel de client HTTP cURL :

curl -X PUT -H "Content-Type: application/json" -d '{
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com"
}' "https://api.example.com/api/users/123"

Cette demande envoie une demande PUT à l'URL /api/users/123 avec les données de l'utilisateur mises à jour dans le corps de la demande. Le serveur traitera alors cette demande en mettant à jour les informations de l'utilisateur dans sa base de données et en renvoyant une réponse au client. La réponse pourrait être un code HTTP de succès (par exemple, 200 OK) si la mise à jour a réussi ou un code d'erreur (par exemple, 404 Not Found) si l'utilisateur spécifié n'a pas été trouvé dans la base de données.

Il est important de noter que les API REST peuvent utiliser différents codes HTTP pour indiquer l'état de la demande et que les méthodes HTTP sont souvent utilisées conjointement avec ces codes pour fournir des informations sur l'action effectuée sur la ressource.

Codes HTTP

Voici quelques exemples de codes HTTP couramment utilisés dans les méthodes HTTP des API REST :

200 OK: Indique que la demande a été traitée avec succès.
201 Created: Indique que la demande a été traitée avec succès et qu'une nouvelle ressource a été créée en conséquence.
204 No Content: Indique que la demande a été traitée avec succès, mais qu'il n'y a pas de contenu à renvoyer.
400 Bad Request: Indique que la demande n'a pas été comprise par le serveur en raison d'une syntaxe erronée.
401 Unauthorized: Indique que l'authentification est nécessaire pour accéder à la ressource.
403 Forbidden: Indique que le serveur a compris la demande, mais qu'il refuse de l'autoriser.
404 Not Found: Indique que la ressource spécifiée n'a pas été trouvée.
500 Internal Server Error: Indique que le serveur a rencontré une erreur inattendue en traitant la demande.

Il existe de nombreux autres codes HTTP qui peuvent être utilisés dans les API REST, mais ceux-ci sont les plus couramment utilisés. Les codes HTTP sont souvent utilisés conjointement avec les méthodes HTTP pour fournir des informations sur l'état de la demande et sur l'action effectuée sur la ressource.

Voici un exemple de code JavaScript qui appelle une API REST avec la méthode HTTP GET pour récupérer une liste d'utilisateurs :

fetch('https://api.example.com/api/users')
  .then(response => response.json())
  .then(users => console.log(users))
  .catch(error => console.error(error))

Ce code utilise la fonction fetch() de JavaScript pour envoyer une demande HTTP GET à l'URL de l'API. La fonction fetch() renvoie une promesse qui est résolue avec la réponse HTTP lorsque la demande est terminée. Nous pouvons utiliser la méthode json() de la réponse pour parser le corps de la réponse en JSON et accéder aux données renvoyées par l'API. Si l'appel de l'API échoue, la promesse est rejetée et nous pouvons utiliser la méthode catch() pour gérer l'erreur.

Voici un exemple de code JavaScript qui appelle une API REST avec la méthode HTTP POST pour créer un nouvel utilisateur :

fetch('https://api.example.com/api/users', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    first_name: 'John',
    last_name: 'Doe',
    email: 'john.doe@example.com'
  })
})
  .then(response => response.json())
  .then(newUser => console.log(newUser))
  .catch(error => console.error(error))

Dans ce code, nous passons un objet options à la fonction fetch() pour spécifier que nous utilisons la méthode HTTP POST et pour inclure les données de l'utilisateur à créer dans le corps de la demande. Nous utilisons également la fonction JSON.stringify() pour convertir les données de l'utilisateur en chaîne de caractères JSON avant de les envoyer dans la demande. Comme dans l'exemple précédent, nous pouvons utiliser la méthode json() de la réponse pour parser le corps de la réponse et accéder aux données renvoyées par l'API.

Il est important de noter que ces exemples ne couvrent qu'une partie des possibilités offertes par les API REST et qu'il existe de nombreuses autres manières de les utiliser en fonction de vos besoins spécifiques.