• 6 heures
  • Facile

Ce cours est visible gratuitement en ligne.

Ce cours est en vidéo.

Vous pouvez obtenir un certificat de réussite à l'issue de ce cours.

J'ai tout compris !

Mis à jour le 09/07/2018

Les ressources

Connectez-vous ou inscrivez-vous gratuitement pour bénéficier de toutes les fonctionnalités de ce cours !

Les ressources sont vraiment le coeur d’une API ! Considérez-les comme une réduction de vos données aux éléments les plus centraux. Comme une API REST est un système d’URI, les ressources déterminent la structure des URI et, du coup, la manière dont une application trouve vos données. “Ressource”, c’est même le deuxième mot dans l’acronyme “URI.” Prenons donc le temps de bien comprendre ce qu’est une ressource.

Comme nous l'avons vu précédemment, des services externes comme Instagram, Gmail, etc. rendent accessible certaines de leurs données à travers une API REST. Les choses auxquelles vous pouvez accéder avec ces API peuvent être des utilisateurs, des photos, des températures...  Ce sont des ressources !

Accéder aux ressources

Prenons le temps de bien assimiler le concept de ressource. La première partie de l'URI est toujours la ressource :

/users

Si vous demandez la forme plurielle d’une ressource, la réponse contiendra tous les objets de cette catégorie. Ici vous recevriez une liste des utilisateurs et leurs attributs comme leur âge, leur adresse, leur taille, etc. (selon ce que l’API a rendu disponible aux clients externes).

Si vous ajoutez des éléments supplémentaires à l’URI, vous recevrez une réponse plus précise. Par exemple, si vous cherchez un utilisateur en particulier, ajoutez l’ID :

/users/238

Vous recevrez les données de l’utilisateur avec l’ID 238, comme son nom, son adresse, etc. selon ce que l’API a mis à votre disponibilité.

Imbrication

Selon la structure des données, une API peut rendre disponibles des ressources associées à une autre ressource, selon un schéma d'imbrication. Supposons par exemple qu’un utilisateur a des adresses associées à son compte.

/users/238/addresses

Néanmoins, cela peut devenir compliqué s'il y a plusieurs associations. Il faut toujours essayer de trouver la manière la plus simple et directe d'accéder aux données. Pour chercher des notes associées à une adresse de livraison par exemple, ce qui suit n’est pas idéal :

/users/238/addresses/195/delivery_notes

Ce qui suit est mieux :

/addresses/195/delivery_notes

Vous voyez à présent les adresses comme une ressource du premier niveau au lieu de passer par user chaque fois. Si vous utilisez une API externe, essayez toujours de construire votre application pour qu’elle envoie des requêtes d'accès aux ressources les plus directes comme dans cet exemple. Si un jour vous développez votre propre API, gardez ces principes en tête pour être sympa avec les développeurs qui utiliseront votre API !

Exemple de certificat de réussite
Exemple de certificat de réussite