API REST
Une API REST est une API qui suit les conventions du web : des ressources identifiées par des URL, des verbes HTTP (lire, créer, modifier, supprimer) et des réponses en JSON.
Mise en contexte
REST est devenu le standard des échanges entre applications parce qu’il s’appuie sur ce que tout navigateur et tout serveur savent déjà faire. Une ressource « réservation » peut être lue à une adresse, créée avec une requête POST, modifiée avec PATCH. Les réponses sont lisibles, les erreurs codifiées.
Nos API Symfony et Node.js suivent ces conventions, avec une documentation OpenAPI générée depuis le code : vos équipes ou un autre prestataire peuvent l’explorer et la tester sans nous. Par exemple, les trois applications de l’A2FM communiquent entre elles par une API REST, l’annuaire alimentant la plateforme d’e-learning et l’outil d’inscriptions.
Quand les besoins deviennent plus fins (récupérer exactement les champs voulus en une requête), GraphQL est une alternative que nous proposons au cas par cas.
Questions fréquentes
REST pour la majorité des intégrations : simple, cacheable, compris par tous les outils. GraphQL quand une interface doit composer beaucoup de données différentes en une requête, par exemple un tableau de bord riche.
Avec une spécification OpenAPI (anciennement Swagger) : chaque point d’entrée, ses paramètres et ses réponses sont décrits dans un format lisible par les humains et par les outils, qui génère une documentation navigable.