8. Conclusion

Nous avons vu beaucoup de choses durant ce chapitre sur la construction des réponses pour une API Rest. Sachez que le sujet est vaste, mais nous avons vu ici les fonctionnalités principales dont nous aurons besoin pour développer notre API Rest. Nous pouvons retourner une réponse valide au format JSON, et structurer nos réponses de façon à simplifier la vie des consommateurs de notre API Rest. Notre modeste API Rest de pokémons a déjà fière allure !

En résumé

  • On juge une API Rest essentiellement sur la qualité des réponses qu’elle renvoie.
  • D’un point de vue purement technique, le rôle d’une API Rest consiste simplement à intercepter une requête HTTP, et retourner une réponse HTTP avec les données au format JSON.
  • Une réponse HTTP est constituée de 3 éléments distincts : les données au format JSON, le type MIME application/json, et enfin le code de statut HTTP.
  • Nous verrons le code statut HTTP plus tard, car il a un rôle plus adapté pour la gestion des erreurs.
  • Pour retourner une réponse HTTP au format JSON, on utilise la méthode json() fournie par Express. Cette méthode s’occupe pour nous de structurer nos données au format JSON, et d’attribuer le type MIME application/json dans la requête de retour.
  • Il existe des extensions pour navigateurs permettant de mieux visualiser les réponses JSON renvoyées par votre API Rest, comme JSON Viewer pour le navigateur Chrome.
  • Une structure de réponse robuste permet de simplifier la vie des développeurs qui devrons consommer notre API Rest plus tard. De plus, cela permet de mieux organiser notre code en interne.