Dans une API RESTful, les endpoints sont les URL spécifiques auxquelles les requêtes HTTP sont adressées pour effectuer des opérations sur les ressources. Ils définissent les actions disponibles pour interagir avec ces ressources.

Qu'est-ce qu'un endpoint ?

Un endpoint est une URL associée à une ressource ou une action sur cette ressource dans une API RESTful.

Chaque endpoint utilise une méthode HTTP spécifique (GET, POST, PUT, DELETE) pour définir l'opération sur la ressource.

Un endpoint suit la structure de l'URL de base de l'API, complétée par un chemin spécifique pour accéder à une ressource.

Par exemple : https://api.exemple.com/users représente la collection des utilisateurs.

Avec les méthodes HTTP :

• 📥 GET : Récupère des données, par exemple pour accéder à une liste d'utilisateurs https://api.exemple.com/users/
• 📤 POST : Crée de nouvelles ressources, par exemple créer un nouvel utilisateur https://api.exemple.com/users
• 🔄 PUT : Met à jour une ressource existante, comme changer des informations sur un utilisateur existant https://api.exemple.com/users/123
• 🗑️ DELETE : Supprime une ressource https://api.exemple.com/users/123

Maintenant, on peut utiliser des paramètres pour ajouter des informations à nos requêtes.

Query Strings

Les Query Strings sont des paires clé-valeur ajoutées à la fin d'une URL après un point d'interrogation ? . Ils permettent de transmettre des données à une application serveur.

On les utilise pour filtrer des résultats ou pour les paginer en fournissant des critères de recherche.

https://api.example.com/users?id=123&name=Claire

• Les paramètres sont séparés par des &.
• Chaque paramètre est une paire clé-valeur avec = pour assigner une valeur à la clé.

Path parameters

Les Path Parameters font partie de l'URL elle-même et sont utilisés pour capturer des parties variables de l'URL.

On les utilise pour accéder à des ressources spécifiques au sein de l'API REST.

https://api.example.com/users/{id}

Bonnes Pratiques

Voilà quelques conseils pour bien structurer tes endpoints.

• 🌟 Clarté et Cohérence : Utiliser des noms descriptifs pour les endpoints.
• 🔄 Versionnement : Inclure des numéros de version pour garantir la compatibilité avec les futures mises à jour de l'API.
• 🔒 Sécurité : Restreindre l'accès aux endpoints sensibles en utilisant des méthodes d'authentification et d'autorisation appropriées.

Les endpoints sont fondamentaux pour manipuler les ressources d'une API RESTful, définissant les actions pour créer, lire, mettre à jour ou supprimer des données. Une conception réfléchie contribue à une API plus accessible, compréhensible et sécurisée.