Qu'est-ce qu'une API REST ?

Qu'est-ce qu'une API REST ?

Une API REST (Representational State Transfer) est un style d'architecture pour la conception d'applications réseau. Elle est largement utilisée pour la création de services web en raison de sa simplicité, de son évolutivité et de sa performance. Voici une introduction aux concepts de base des API REST, aux méthodes HTTP couramment utilisées, et au format de données JSON.

Définition et concepts de base

• Définition : Une API REST est une interface qui permet à différents systèmes de communiquer entre eux via le protocole HTTP. Elle est basée sur des principes d'architecture qui favorisent une interface uniforme, un système sans état, la mise en cache, et une structure en couches.

• Ressources : Dans une API REST, tout est considéré comme une ressource. Une ressource peut être n'importe quel objet ou donnée, comme un utilisateur, un produit, ou un article. Chaque ressource est identifiée par une URL unique.

• Représentation : Les ressources sont échangées sous forme de représentations, généralement au format JSON ou XML. Ces représentations contiennent les données de la ressource ainsi que des métadonnées décrivant son état actuel.

• Sans état : Chaque requête d'un client à un serveur doit contenir toutes les informations nécessaires pour comprendre et traiter la requête. Le serveur ne stocke aucune information sur l'état du client entre les requêtes.

• Uniformité : Les API REST utilisent une interface uniforme pour simplifier l'architecture. Cela signifie que les mêmes conventions sont utilisées pour toutes les interactions, comme l'utilisation de méthodes HTTP standard pour les opérations CRUD (Create, Read, Update, Delete).

Méthodes HTTP

Les méthodes HTTP sont utilisées pour indiquer l'action souhaitée sur une ressource. Voici les méthodes HTTP les plus couramment utilisées dans les API REST :

• GET : Utilisée pour récupérer des données d'une ressource spécifique. Les requêtes GET sont sans effet de bord, ce qui signifie qu'elles ne modifient pas l'état de la ressource.

  GET /api/aliments
  

• POST : Utilisée pour envoyer des données à un serveur afin de créer une nouvelle ressource. Les requêtes POST ne sont pas idempotentes, ce qui signifie que l'envoi de la même requête plusieurs fois peut avoir des effets différents.

  POST /api/aliments
  Content-Type: application/json
  
  {
      "nom": "Pomme",
      "type": "fruit",
      "emoji": "🍎"
  }
  

• PUT : Utilisée pour mettre à jour une ressource existante. Les requêtes PUT sont idempotentes, ce qui signifie que l'envoi de la même requête plusieurs fois aura le même effet que l'envoi de la requête une seule fois.

  PUT /api/aliments/1
  Content-Type: application/json
  
  {
      "nom": "Pomme mise à jour",
      "type": "fruit",
      "emoji": "🍎"
  }
  

• DELETE : Utilisée pour supprimer une ressource spécifique. Les requêtes DELETE sont idempotentes, ce qui signifie que l'envoi de la même requête plusieurs fois aura le même effet que l'envoi de la requête une seule fois.

  DELETE /api/aliments/1
  

Format des données : JSON

JSON (JavaScript Object Notation) est un format de données léger et facile à lire et à écrire pour les humains, ainsi qu'à analyser et à générer pour les machines. Il est largement utilisé comme format de données pour les API REST en raison de sa simplicité et de sa compatibilité avec de nombreux langages de programmation.

• Structure de base : JSON est basé sur deux structures principales : une collection de paires clé-valeur (objet) et une liste ordonnée de valeurs (tableau).

  • Objet : Un objet JSON est une collection non ordonnée de paires clé-valeur, où les clés sont des chaînes de caractères et les valeurs peuvent être des chaînes, des nombres, des booléens, des tableaux, ou d'autres objets.

    {
        "nom": "Pomme",
        "type": "fruit",
        "emoji": "🍎"
    }
    

  • Tableau : Un tableau JSON est une liste ordonnée de valeurs, qui peuvent être de n'importe quel type de données JSON.

    [
        {
            "nom": "Pomme",
            "type": "fruit",
            "emoji": "🍎"
        },
        {
            "nom": "Banane",
            "type": "fruit",
            "emoji": "🍌"
        }
    ]
    

     

En utilisant ces concepts et méthodes, les API REST permettent une communication efficace et standardisée entre les clients et les serveurs, facilitant ainsi le développement d'applications web et mobiles modernes.