• 50 heures
  • Difficile

Ce cours est visible gratuitement en ligne.

course.header.alt.is_video

course.header.alt.is_certifying

J'ai tout compris !

Mis à jour le 29/07/2019

Les outils indispensables à tout bon développeur d'API

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

 

Voyons ensemble les outils permettants de développer en toute sérénité : tout bon développeur d'API qui se respecte doit avoir dans son baluchon de bons outils pour être le plus productif possible.

Nous allons avoir besoin d'interroger notre API de toutes sortes de manières, en faisant varier les headers et contenus de notre requête en particulier. Pour se faire, deux outils s'offrent à vous : le premier est graphique et très facile à prendre en main, j'ai nommé Postman ! Le second outil est à utiliser en ligne de commande, il est appelé Curl.

Postman

Non non, il ne s'agit pas d'un nouveau super-héros, mais bien d'un logiciel. Rendez-vous sur la page officielle pour télécharger l'application et/ou installer l'extension chrome très pratique.

Pour la suite de ce cours, je n'utiliserai que l'extension Chrome. ;)

Pour accéder à l'extension, il vous suffit de taper dans la barre d'adresse "chrome://apps/" puis de cliquer sur l'icône de Postman pour l'ouvrir.

Icône de l'extension chrome Postman
Icône de l'extension Chrome Postman

 Lorsque l'on clique dessus, le logiciel nous demande de nous connecter. C'est inutile. Cliquez sur le lien "Skip this, go straight to the app".

Première étape d'utilisation de Postman
Première étape d'utilisation de Postman

 Et voilà, bienvenue sur l'interface de Postman :

Première interface à l'ouverture de Postman
Première interface à l'ouverture de Postman

Je vous propose de faire un petit tour de l'application ensemble. Vous verrez, c'est très simple à prendre en main.

Faire une requête GET

Commençons par une requête GET : Postman nous fournit des URLs de test, nous allons en faire usage pour faire nos premières armes sur l'outil.

Effectuer une requête GET
Effectuer une requête GET

Lorsque vous cliquez sur le bouton "Send", voici le résultat obtenu :

Résultat de la requête GET
Résultat de la requête GET

De nouveaux éléments sont apparus sur l'interface ! Détaillons-les ensemble :

  1. On retrouve le contenu de la réponse suite à la requête effectuée ;

  2. On peut voir le code status de la réponse (ici, c'est 200) et le temps qui s'est écoulé entre l'émission de la requête et la réception de la réponse ;

  3. Une nouvelle entrée est apparue à gauche de l'écran, dans l'encart "History". En cliquant dessus, vous serez en mesure de rejouer la requête sans effort.

 Toujours sur le même écran, cliquez sur l'onglet "Headers (13)". Voici ce qui est affiché :

Afficher les headers de la réponse HTTP
Afficher les headers de la réponse HTTP

Comme vous pouvez le constater, nous pouvons examiner l'ensemble des entêtes (headers) de la réponse. Cela nous sera très utile pour nous assurer que notre application a bien fait le travail escompté.

 Modifier la méthode HTTP

Cette fois-ci nous allons changer d'URL pour effectuer une requête POST :

Modifier la méthode HTTP d'une requête
Modifier la méthode HTTP d'une requête

 Pour ajouter les paramètres à envoyer en POST, il suffit de cliquer sur l'onglet "Body" :

Onglet body pour ajouter les paramètres en POST
Onglet "Body" pour ajouter les paramètres en POST

En fonction de la manière dont vous souhaitez poster les informations, plusieurs options s'offrent à vous.

Pour simuler le fonctionnement d'un formulaire, il suffit de sélectionner le radio bouton "form-data" et remplir les champs :

Résultat d'une requête POST
Résultat d'une requête POST

Comme vous pouvez le voir, vous êtes en mesure d'envoyer des informations textuelles et un fichier, tout comme le ferait un formulaire HTML.

Ajouter un ou plusieurs header(s) à une requête 

Une autre fonctionnalité qui nous servira bien souvent lors du développement d'API, le fait d'ajouter des headers particuliers pour une requête. C'est tout à fait utile parce qu'il faudra toujours indiquer quel type de contenu est attendu en réponse. Le header à ajouter est  Content-Type: application/json , voici comment procéder :

Ajouter un header à une requête
Ajouter un header à une requête

Il faut cliquer sur l'onglet "Header", puis remplir les champs un à un. Vous pouvez ajouter autant de headers que vous le souhaitez.

 

Au fur et à mesure du cours, nous découvrirons d'autres fonctionnalités. Un peu de patience ! :D En attendant, n'hésitez pas à essayer un peu tous les boutons, cela ne peut pas faire de mal ! :lol:

Curl

L'utilisation de Curl se fait via la ligne de commande. C'est un peu moins joli à utiliser, mais plutôt fonctionnel.

Voici un exemple de requête POST avec Curl :

$ curl 127.0.0.1\
-H "Accept: application/json"\
-X POST\
-u myuser:pass\
--data '{"message":"hello"}'

 Le premier argument,  127.0.0.1  n'est autre que l'host que nous cherchons à contacter. Détaillons dès maintenant les options qui suivent :

  •  -H  correspond aux headers que nous souhaitons ajouter à la requête ;

  •  -X  correspond à la méthode HTTP que nous souhaitons utiliser ;

  •  -u  correspond aux informations que nous souhaitons faire passer pour une authentification HTTP ;

  •  --data  correspond au contenu (body) de la requête.

Bien évidemment, il existe pléthore d'autres options. Pour les explorer, je vous invite à taper la commandecurl --helpet faire un petit tour du propriétaire. ^^

 

Il est temps de voir en détail de quoi il en retourne concernant l'élément central d'une API : les ressources.

 

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