Mini-leçon · Français

Comment afficher les données d’une API externe sur votre site

Utilisez la page prête de recherche de dépôt, ajoutez un résultat utile avec l’assistant et vérifiez réponses normales, absentes et indisponibles.

Commencer le cours interactifLire les notes du cours

À qui s’adresse cette leçon ?

Pour les personnes souhaitant afficher des informations actuelles d’un autre service. La page et l’assistant gèrent le code navigateur ; concentrez-vous sur le résultat.

Avant de commencer

L’atelier fourni, Internet et un aperçu HTTP local que l’assistant peut démarrer. Cet exemple lit des dépôts GitHub publics sans jeton privé ; disponibilité et limites de requêtes s’appliquent.

Durée estimée: 14–26 min

Estimations avec les fichiers fournis et les comptes et outils requis déjà prêts. La configuration, les files de déploiement et les délais de messagerie ou de DNS demandent du temps supplémentaire. Les requêtes GitHub sans authentification partagent un quota lié à l’adresse IP ; des tests répétés peuvent l’atteindre.

Ce que vous apprendrez

  • Recherchez un vrai dépôt public.
  • Affichez un résultat supplémentaire utile avec un assistant.
  • Distinguez absence de dépôt et indisponibilité du service.

Fichiers de l’atelier

Étape 1

Ouvrez la recherche prête à l’emploi

Demandez une valeur au service au lieu de saisir un nombre fixe dans la page.

Faites démarrer le dossier public fourni sur HTTP. Utilisez l’exemple octocat / Hello-World du modèle et activez le bouton de recherche.

Comparez l’identité et le nombre renvoyés avec le résultat du service à cet instant. Ne figez pas un ancien nombre dans le code comme s’il était actuel.

Un exemple concret

Un nombre d’étoiles enregistré dans le texte de la page ne peut pas suivre les changements du dépôt.

Démarre la recherche de dépôt public sur HTTP local. Préserve le rendu texte sûr et n’ajoute aucun jeton privé aux fichiers navigateur. Aide-moi à tester un dépôt réel, un dépôt absent et une requête en échec. Ajoute ensuite le nombre documenté d’éléments ouverts et aide-moi à le comparer à la réponse API. Gère le code pour moi.

GitHub : obtenir un dépôt

Fichiers de cette étape

Start hereFichiers de l’atelier

Open or download the files below. When saving a project, keep the folder paths shown in the filenames.

How it works (optional)

Affichez les données d’un autre service

Chargez depuis GitHub le nom, la description et le nombre d’étoiles d’un dépôt public.

Une API est une manière définie pour un logiciel de demander des données ou une action. Ici, votre site demande un dépôt à GitHub et reçoit du JSON plutôt qu’une page HTML.

Nous utilisons une lecture publique pour apprendre à gérer les requêtes sans commencer par l’authentification. Le résultat peut changer entre deux requêtes ; c’est une observation actuelle, pas un nombre à inscrire en dur.

Exemple détaillé

Pour le propriétaire octocat et le dépôt Hello-World, le chemin demandé est /repos/octocat/Hello-World sur api.github.com. La page affiche les champs full_name et stargazers_count reçus.

GitHub : obtenir un dépôt

Extra implementation exercise

Quelle différence y a-t-il entre copier un nombre d’étoiles dans le HTML et le récupérer quand on appuie sur le bouton ?

Afficher une solution détaillée

Le HTML copié conserve l’ancienne valeur jusqu’à sa modification. Un fetch demande la réponse actuelle à cet instant, mais exige de gérer le chargement et les échecs, car le service ou le réseau peut ne pas répondre.

  • Explique à quel moment la valeur est obtenue.
  • Reconnaît que la requête externe peut échouer.

Étape 2

Vérifiez une réponse réussie

Utilisez une observation comparable à la source.

Demandez d’afficher la réponse API publique correspondant au dépôt de test et vérifiez les valeurs affichées. Gardez le test public et non sensible.

Une requête retournant une erreur ne doit pas être traitée comme un résultat normal. Vous n’avez pas à écrire le code de requête/erreur pour juger le résultat visible.

Un exemple concret

Valeurs illustratives : full_name = practice/example et stargazers_count = 12 doivent devenir le nom visible practice/example et 12 stars. Ces valeurs fictives expliquent la correspondance, pas le nombre actuel de l’exemple GitHub fourni.

Fichiers de cette étape

Start hereFichiers de l’atelier

Open or download the files below. When saving a project, keep the folder paths shown in the filenames.

How it works (optional)

Construisez et vérifiez une requête

Encodez la saisie de l’utilisateur et examinez la réponse avant de l’utiliser.

Lisez public/app.js et exécutez la page fournie en HTTP. encodeURIComponent garde chaque valeur de propriétaire ou de dépôt dans son propre segment de chemin. L’hôte est fixe ; le visiteur ne fournit pas une destination arbitraire.

fetch se résout même pour des erreurs HTTP comme 404 : attendre son résultat ne suffit donc pas. Vérifiez response.ok et les statuts pertinents, analysez le JSON, puis vérifiez les champs nécessaires à la fonction. textContent affiche les chaînes externes comme du texte.

Le court extrait ci-dessous illustre le contrôle HTTP général. Le fichier app.js complet traite d’abord spécifiquement les réponses 404 et celles liées aux restrictions ou limites de requêtes, puis vérifie les autres statuts d’échec, analyse le JSON et valide les champs. Conservez cet ordre lorsque vous ajoutez un champ affiché.

Exemple détaillé

Une description contenant des chevrons doit rester du texte visible et ne pas devenir du balisage de page. Un 404 doit afficher un message d’absence ou d’accès public manquant, plutôt qu’une carte de réussite vide.

if (!response.ok) throw Error('Request failed');
const data = await response.json();
result.textContent = data.full_name;

Extra implementation exercise

Pourquoi try/catch ne détecte-t-il pas à lui seul toutes les réponses HTTP en échec ?

Afficher une solution détaillée

Les erreurs HTTP peuvent quand même produire un objet Response normal. Vérifiez status/ok et déclenchez ou traitez l’erreur avant de considérer son corps comme le dépôt demandé.

  • Sait que fetch peut se résoudre avec 404 ou 500.
  • Vérifie le statut avant d’afficher une réussite.

Étape 3

Essayez absence et indisponibilité

Rendez les différents échecs compréhensibles.

Essayez un nom de dépôt inexistant. Avec l’assistant, testez aussi une requête bloquée/ratée dans la page locale. Gardez la recherche saisie pour corriger ou réessayer.

La page doit distinguer dépôt absent et panne temporaire. N’ajoutez pas de jeton privé au navigateur pour contourner une limite de requêtes.

Un exemple concret

« Dépôt introuvable » et « Service indisponible ; réessayez » proposent au visiteur des actions suivantes différentes.

GitHub : limites de requêtes de l’API REST

Fichiers de cette étape

Start hereFichiers de l’atelier

Open or download the files below. When saving a project, keep the folder paths shown in the filenames.

How it works (optional)

Rendez les états d’échec distincts

L’absence de dépôt, l’absence de réseau et l’épuisement du quota sont des problèmes différents.

Testez un vrai dépôt public, un nom manifestement inexistant et le mode hors connexion du navigateur. L’interface efface l’ancien résultat avant une nouvelle requête, empêche les doubles envois et réactive ensuite le bouton.

GitHub peut rejeter les requêtes non authentifiées à cause de limites liées à l’IP. N’y répondez pas en plaçant un jeton privé dans le navigateur. Pour un usage authentifié régulier, utilisez les identifiants dans une route serveur contrôlée et mettez en cache lorsque c’est approprié.

Exemple détaillé

Si une carte de réussite reste visible sous “Not found” (introuvable), un visiteur peut prendre des données anciennes pour le nouveau résultat. Effacer l’ancien résultat rend l’état de la requête actuelle sans ambiguïté.

GitHub : limites de requêtes de l’API REST

Extra implementation exercise

Une recherche échoue après de nombreux tests. L’interface doit-elle annoncer que le dépôt a zéro étoile ?

Afficher une solution détaillée

Non. Zéro est une véritable valeur de données. Signalez des données indisponibles ou restreintes et examinez le statut ; le nombre est inconnu tant qu’une réponse réussie ne le fournit pas.

  • Ne transforme pas des données indisponibles en zéro.
  • Vérifie le statut de la requête et les indices relatifs au quota.

Étape 4

Ajoutez un résultat utile

Décrivez l’information nouvelle et laissez l’assistant la connecter.

Demandez d’ajouter open_issues_count à côté du résultat existant et de l’intituler open issues and pull requests. Ce total GitHub comprend les deux catégories ; il ne doit pas devenir un simple nombre de bugs. Consultez la référence après avoir essayé votre version.

Comparez la valeur affichée à la réponse réelle, puis répétez réussite, dépôt absent et indisponibilité. Vous jugez le sens et les états observés ; l’assistant réalise le code du navigateur.

Un exemple concret

Un open_issues_count fictif de 5 pourrait représenter deux issues ouvertes et trois pull requests ouvertes. « 5 bugs » affirmerait quelque chose que ce champ ne démontre pas.

Fichiers de cette étape

Start hereFichiers de l’atelier

Open or download the files below. When saving a project, keep the folder paths shown in the filenames.

How it works (optional)

Votre devoir : ajouter un champ de dépôt utile

Ajoutez un nombre de tickets en préservant une distinction claire entre données et erreurs.

Affichez open_issues_count après avoir vérifié qu’il s’agit d’un nombre fini. Notez que le total GitHub comprend les demandes de fusion, comme indiqué dans la documentation ; ne le présentez pas comme un décompte exact des seuls rapports de bogues.

Consignez une recherche réussie, un dépôt absent et un essai hors connexion. Incluez ce que voit le visiteur pendant la requête et après chaque issue.

Exemple détaillé

Un libellé comme “Open issues and pull requests” (tickets et demandes de fusion ouverts) décrit la mesure plus précisément que “Bugs” (bogues).

Le parcours de référence complet est disponible dans reference/assignment-walkthrough.txt. Comparez ses étapes avec votre résultat ; remplissez le relevé de test à partir de vos propres observations sur votre projet.

Extra implementation exercise

Complétez le résultat avec le décompte documenté des éléments ouverts et démontrez les trois états.

Afficher une solution détaillée

Ajoutez open_issues_count aux champs validés après le traitement des statuts réussis. Exigez un nombre fini, puis utilisez le libellé 'Open issues and pull requests', car ce champ de dépôt GitHub comprend les deux. Le script de référence complet conserve l’affichage par textContent et les états de chargement et d’erreur existants.

Jeu de données d’exemple : full_name='sample/site', stargazers_count=3, open_issues_count=2 produit 'sample/site — 3 stars — 2 open issues and pull requests'. Cela affiche trois étoiles et deux tickets ou demandes de fusion ouverts, sans affirmer que les deux éléments sont des bogues.

Testez à nouveau un dépôt public valide, un 404 et le mode hors connexion. Effacez la carte précédente au début de la recherche suivante ; une erreur ne doit ni conserver des nombres périmés ni remplacer des données indisponibles par zéro.

  • Valide le nombre ajouté et le désigne avec précision.
  • Aucune ancienne réussite ne reste affichée après l’échec d’une nouvelle recherche.

Cette leçon vous a-t-elle été utile ?

Laissez un J’aime ou partagez-la avec quelqu’un qui pourrait en profiter.

Poursuivre votre apprentissage

Explorer les autres leçons