Documentation API
Documente une authentification et une erreur 401 dans une page navigable au clavier.
Objectifs de la leçon
- Comprendre le rôle de « Documentation API ».
- Appliquer une modification courte et vérifiable.
- Expliquer pourquoi les tests prouvent la réussite.
Contexte
Une équipe intègre une API et doit retrouver rapidement son mécanisme d'authentification ainsi que la signification d'une réponse 401. Écris une documentation courte mais exploitable : un exemple d'en-tête, une explication du jeton invalide et une navigation vers ces deux sujets. Le jeton montré doit rester une valeur fictive, jamais un secret réel.
Contraintes
Place le lien d'évitement avant la navigation. Chaque fragment doit résoudre un identifiant unique. Utilise pre et code pour conserver la forme de l'exemple, puis des titres hiérarchisés pour que les sections restent identifiables sans présentation graphique.
Preuves
Depuis le début de la page, active le lien d'évitement avec Entrée et vérifie le déplacement du focus au contenu. Teste ensuite chaque lien de section et consulte l'ordre des titres. Explique pourquoi une simple présence de href ne prouve pas qu'une destination existe.
Vocabulaire lié
Validation
- La solution ajoute la structure minimale demandée avant toute décoration.
- Chaque attribut important est relié à un besoin : navigation, nom accessible, validation ou information machine.
- Les tests confirment la présence, le nombre ou la relation attendue ; ils ne valident pas seulement du texte décoratif.