Inspecter des réponses - Cloud

Guide d'utilisation de Talend Cloud API Tester

EnrichVersion
Cloud
EnrichProdName
Talend Cloud
EnrichPlatform
Talend API Tester
task
Création et développement > Test d'API
Inspectez les réponses affichées par Talend Cloud API Tester.

Talend Cloud API Tester dispose d'une zone dédiée à l'affichage des réponses. Cette zone mappe les différents éléments d'une réponse.

Code de statut et message

Le code de statut et message indique le statut de la réponse. Le code de statut est un nombre normalisé. HTTP définit différentes familles à ce niveau : 2xx pour un succès, 3xx pour une redirection, 4xx pour des erreurs client et 5xx pour des erreurs serveur.

Pour plus d'informations sur les statuts de codes, consultez Response statut code (en anglais).

En-têtes

La liste des en-têtes HTTP de la réponse est disponible sous deux formats : le mode par défaut est le mode pretty dans lequel tous les en-têtes sont listés dans un tableau avec des alignements lisibles des noms et des valeurs. Le deuxième mode est le mode raw dans lequel tous les en-têtes sont affichés tel qu'ils sont reçus. Ce format est bien plus compacte et peut être moins bien lisible.

Talend Cloud API Tester comprend une liste d'en-têtes de réponse et propose des actions utiles lorsque vous cliquez dessus. Consultez la table ci-dessous pour une liste complète.

En-tête de réponse Action
Location L'URL de la requête courante est remplacée par la valeur de l'en-tête.
x-xrds-location L'URL de la requête courante est configurée avec la valeur de l'en-tête.
Set-Cookie Un nouvel en-tête Cookie est ajouté à la requête avec la valeur de l'en-tête.
Etag Un nouvel en-tête If -None-Match est ajouté à la requête avec la valeur de l'en-tête (pour plus d'informations, consultez Conditional Requests (en anglais)).
Last-Modified Un nouvel en-tête If-Modified-Since est ajouté à la requête avec la valeur de l'en-tête (pour plus d'informations, consultez Conditional Requests (en anglais)).
Expires Un nouvel en-tête If-Modified-Since est ajouté à la requête avec la valeur de l'en-tête (pour plus d'informations, consultez Conditional Requests (en anglais)).
Cache-Control Si la valeur est une directive Cache-Control max-age ou s-max-age, alors un nouvel en-tête Cache-Control est ajouté à la requête avec la valeur max-age=0.
Allow Ces en-têtes contiennent une liste de méthodes HTTP cliquables. Après avoir cliqué dessus, la méthode de la requête courante est mise à jour.
Access-Control-Allow-Methods Ces en-têtes contiennent une liste de méthodes HTTP cliquables. Après avoir cliqué dessus, la méthode de la requête courante est mise à jour.

Payload de la réponse

Le payload de la réponse est la donnée reçue. Pour faciliter la lecture, les payloads peuvent être affichés tels qu'ils sont (mode raw) ou encodés hex (mode hex). Certains payloads peuvent aussi être formatés à l'aide de coloration syntaxique et d'autres options (mode pretty) ou bien en mode preview :

  • raw affiche les octets des payloads. Il peut en résulter des effets non désirés lorsqu'appliqué à des payloads "binaires".
  • hex affiche chaque octet du payload dans leur représentation hexadécimale.
  • preview convient bien aux images, payloads HTML, etc. Il est demandé au navigateur d'afficher le payload en fonction de son type de média. Les fichiers binaires ne sont pas affichés.
  • pretty supporte diverses options comme la coloration syntaxique. Elles sont listées dans la table ci-dessous.

Les modes raw et hex sont disponibles pour tous types de payloads. Le mode preview est disponible pour les payloads HTML, images et binaires. Pour ce dernier, un message s'affiche, expliquant que les fichiers binaires ne peuvent pas être prévisualisés.

Voici les options disponibles dans le mode "pretty" :

Type de payload Coloration syntaxique Numéros de ligne Développer/réduire les nœuds Clickable URLs
XML oui oui oui oui
JSON oui oui oui oui
HTML oui non non oui

Dans API Tester Settings > APPEARANCE, vous pouvez configurer les options d'affichage de la réponse pour chaque type de contenu.

Vous pouvez voir le temps écoulé depuis la requête dans le coin supérieur droit et la longueur du corps dans le coin inférieur droit de la section Response.

En-têtes de requêtes complets

Cette section affiche les en-têtes habituellement gérés par le navigateur et les valeurs ayant été envoyées. Avec Talend Cloud API Tester, vous pouvez laisser le navigateur gérer ces en-têtes pour vous ou vous pouvez en prendre le contrôle.

Comportement du navigateur

Le navigateur Chrome ajoute des en-têtes additionnels à vos requêtes HTTP s'ils ne sont pas fournis, comme:

  • User-Agent ;
  • Accept, Accept-Encoding, Accept-Language ;
  • Cookie.

Les en-têtes envoyés sont affichés dans la partie de la réponse Complete request headers.

Vous pouvez cliquer sur ces valeurs pour les définir comme faisant parties de votre requête. Si besoin, il est possible de les écraser.

Si vous automatisez les tests de votre API, il est recommandé d'écraser explicitement les en-têtes utiles à votre API de façon à pouvoir en reproduire le comportement avec l'outil d'automatisation.

Cookies

Talend Cloud API Tester utilise le système de gestion des cookies de Google Chrome.

Si Google Chrome a stocké un cookie lié à un domaine particulier, ce cookie sera ajouté à la requête envoyée avec Talend Cloud API Tester à ce domaine.

Si vous ne souhaitez pas que les cookies soient ajoutés dans une requête, définissez simplement un en-tête Cookie avec une valeur vide pour écraser ce comportement.

Assistants d'édition de requête

Dans le mode pretty, si possible, les URL sont parsées et mises en valeur. Lorsque vous cliquez sur le lien, la requête est mise à jour :

  • le champ de l'URL de la requête courante est mis à jour avec la valeur du lien (les liens relatifs sont calculés avec l'URL de la requête courante) ;
  • la méthode de la requête courante est configurée à GET.

Cela est utile si vous souhaitez naviguer sur votre API de la même façon que vous naviguez sur Internet : en suivant les liens des pages. Si vous requêtez d'abord à votre API un contact et si le corps contient des liens vers l'adresse du contact, vous pouvez obtenir rapidement la représentation de l'adresse en deux clics :

  1. cliquez sur le lien pour actualiser la requête courante ;
  2. envoyez la nouvelle requête.

Actions supplémentaires

  • 2Request : copie le payload de la réponse dans le payload de la requête. Si la requête ne supporte pas le payload (par exemple GET) alors la méthode est automatiquement mise à jour sur POST.
  • Copy : copie le payload de la réponse dans le presse-papier, les payloads JSON ou XML sont indentés.
  • Download : télécharge le payload de réponse sur le disque local.

Prévisualisation/réponse de la requête

Vous pouvez prévisualiser la requête que vous configurez et obtenir la réponse entière en texte brut dans l'onglet HTTP, dans le panneau du bas.