Chapitre 5. Documentation de l'API
Cet ouvrage a été traduit à l'aide de l'IA. Tes réactions et tes commentaires sont les bienvenus : translation-feedback@oreilly.com
C'est dans la documentation que les développeurs viennent se renseigner sur ton API. Que tu fournisses un simple fichier README ou que tu développes un site Web complet pour tes développeurs, il est essentiel de documenter clairement la façon dont ils peuvent utiliser ton API le plus efficacement possible.
Brenda Jin, Saurabh Sahni et Amir Shevat, Designing Web APIs (O'Reilly, 2018).
Au chapitre 4, tu as créé ta première API pour répondre aux histoires d'utilisateurs identifiées au chapitre 1. Les principaux utilisateurs pour lesquels tu les as développées sont les utilisateurs de science des données et les fournisseurs de sites Web de conseils. L'API leur permettra de créer des produits analytiques tels que des tableaux de bord, des graphiques et des modèles en utilisant les données de fantasy de SportsWorldCentral (SWC). Tu vas maintenant créer de la documentation pour les aider à utiliser ton API. La documentation et les fonctionnalités telles que les kits de développement logiciel (SDK) améliorent l'expérience du développeur (DX) pour tes utilisateurs techniques.
Envoyer un signal de confiance
Une tâche importante de ton API docs est de signaler la confiance aux consommateurs potentiels de l'API. S'ils ne te font pas confiance, ils n'utiliseront pas ton API. Si les consommateurs d'API ont l'intention d'appeler ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access