Menu documentation

Client API

Dernière mise à jour le - Available in English

Pour les frameworks backend tels que Node.js, Ruby on Rails, Spring, Gin et Django, vous et vos candidats aurez accès à un client API RESTful que vous pourrez utiliser pour tester la conception API de votre candidat.

Pour accéder au client API, il suffit de cliquer sur l'onglet Demandes API en haut à droite de l'écran.

L'onglet Demande d'API est mis en évidence dans le haut de la fenêtre pad de droite.
Cliquez sur l'image pour l'agrandir.

Le client API est divisé en trois sections :

L'image montre une interface de test de demande d'API, probablement dans un environnement de codage ou de développement. Voici une décomposition détaillée de l'interface:1 **Section requête API:** - En haut, il y a une section pour configurer la requête API. La méthode sélectionnée est `GET`, et le point de terminaison testé est `/test`. - Le type de corps de la requête est `JSON`. Il y a un champ vide en dessous où le corps de la requête peut être entré si nécessaire.2. **Response Section:** - En dessous de la section de requête se trouve la zone de réponse. La réponse affiche un code de statut `200 OK`, indiquant que la requête a réussi. - Le corps de la réponse est affiché dans un format "Pretty" et contient un objet JSON : `{"data" : "Hello World !"}`.3. **Historique des requêtes:** - En bas de l'interface, il y a un panneau "Historique des requêtes" montrant les requêtes API précédentes. L'historique montre trois requêtes `GET` faites au point de terminaison `/test`, dont l'une inclut des paramètres de requête (`/test?id=lsdkj/30293&location=gotham_city`). En outre, l'interface comprend des onglets en haut pour "Program Output", "Private Interviewer Notes", et "API Requests" (l'onglet actuellement actif). En bas de l'écran, des options permettent de fournir un retour d'information, d'ajuster les paramètres ou de mettre fin à la session d'entretien.

Fenêtre de demande

La première partie de la fenêtre du client API se compose des éléments suivants :

  1. Une liste déroulante de verbes HTTP
  2. La barre d'URL
  3. L'interprète et l'environnement Envoyer pour envoyer votre message au(x) point(s) de terminaison que vous avez créé(s) dans l'éditeur.
  4. L'interprète et l'environnement Clair pour réinitialiser la fenêtre de votre client API.
La fenêtre client API avec un #1 à côté de la liste déroulante des verbes HTTP en haut à gauche, un #2 à côté de la barre d'url en haut au centre, un #3 à côté du bouton d'envoi à droite de la barre d'url, et un #4 à côté du bouton d'effacement qui est à droite du bouton d'envoi.

Corps

Vous pouvez définir votre charge utile de corps à JSON, Form, ou Texte dans la liste déroulante :

JSON

Forme

Texte

Un exemple de message JSON.
Un exemple de liste de formulaires avec les noms et les valeurs de deux lignes remplies.
Pour ajouter une ligne de formulaire, cliquez sur Ajouter +. Pour effacer une ligne de la liste des formulaires, il suffit de cliquer sur l'icône de la poubelle située à droite de la ligne.
Texte aléatoire dans la fenêtre de texte pour le corps de la demande.

Cookies

Vous pouvez créer des cookies en sélectionnant l'onglet Cookies sous l'URL. Vous avez la possibilité d'entrer les données suivantes pour le cookie :

  • Nom
  • Valeur
  • Expiration : (date d'expiration)
  • Domaine
  • Chemin d'accès
La fenêtre de demande avec l'onglet cookies sélectionné. Deux cookies sont saisis avec les champs nom, valeur, expiration, domaine et chemin remplis de données types.

Pour ajouter un cookie, cliquez simplement sur +Add. Pour supprimer une ligne, cliquez sur l'icône de la poubelle à droite de la ligne que vous souhaitez supprimer.

En-têtes

Vous pouvez ajouter des en-têtes en sélectionnant l'onglet En-têtes sous l'URL, puis en saisissant le couple Nom-Valeur approprié.

L'onglet headers est sélectionné avec une ligne remplie avec content-type pour le nom et application/json pour la valeur.

Pour ajouter un en-tête, cliquez simplement sur +Add. Pour supprimer une ligne, cliquez sur l'icône de la poubelle à droite de la ligne que vous souhaitez supprimer.

Params

Vous pouvez ajouter des paramètres de requête en sélectionnant l'onglet Params sous l'URL, puis en saisissant la paire Nom-Valeur appropriée. Notez que lorsque vous ajoutez les paramètres, l'URL se remplit automatiquement avec la syntaxe appropriée.

L'onglet Params est sélectionné dans la fenêtre du client api. Deux lignes sont remplies et sont reflétées dans la barre d'url en haut de la fenêtre.

Pour ajouter un nouvel en-tête, cliquez simplement sur +Add. Pour supprimer une ligne, cliquez sur l'icône de la poubelle à droite de la ligne que vous souhaitez supprimer.

Fenêtre de réponse

Dans le coin supérieur droit de la fenêtre de réponse, vous pouvez voir rapidement l'état de la réponse du serveur et le temps de réponse :

Une fenêtre de réponse avec une flèche pointant vers le statut du serveur, qui est "200 OK" et un temps de réponse de 47 ms.

Corps

Le corps de la réponse sera dans le format que votre point de terminaison est configuré pour produire. Vous avez la possibilité de Pretty le corps de la réponse pour une meilleure lisibilité :

Pretty bascule sur.

Pretty de basculer hors.

Prettified json.
JSON brut.

En-têtes

Pour afficher les en-têtes de réponse, il suffit de cliquer sur l'onglet En-têtes :

L'onglet des en-têtes est sélectionné dans la fenêtre de réponse et les rubriques telles que "connexion", "date" et "content-type" sont remplies.

Fenêtre d'historique des demandes

Vous pouvez consulter l'historique de vos demandes et relancer d'anciennes demandes en sélectionnant l'onglet Historique des demandes puis en cliquant sur la demande précédente que vous souhaitez consulter ou relancer :

L'onglet Historique des requêtes s'affiche avec sept requêtes précédentes affichées avec leur verbe HTTP et leur url.

✅ Si vous essayez de cliquer sur un élément de l'historique des demandes alors que vous avez une demande non envoyée en haut, vous obtiendrez une modale vous invitant à remplacer/effacer la fenêtre de demande et à la remplacer par les données de l'élément de l'historique des demandes sur lequel vous venez de cliquer.

Une modale qui indique "vous avez une demande non envoyée. Si vous quittez ce formulaire de demande, toutes les modifications en cours seront annulées". En dessous, deux boutons, un qui indique "annuler les modifications en cours" et un autre qui indique "retourner au formulaire".

Vous pourrez également revoir l'Demande d'historique du candidat dans la fenêtre de lecture une fois l'entretien terminé :