March 2025
Intermediate to advanced
352 pages
9h 39m
Italian
Content preview from API pratiche per l'IA e la scienza dei dati
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,
Start your free trial
Capitolo 5. Documentare l'API
Questo lavoro è stato tradotto utilizzando l'AI. Siamo lieti di ricevere il tuo feedback e i tuoi commenti: translation-feedback@oreilly.com
La documentazione è il luogo in cui gli sviluppatori vengono a conoscere la tua API. Sia che tu fornisca un semplice file README o che tu stia sviluppando un sito web completo per i tuoi sviluppatori, è fondamentale documentare chiaramente come questi ultimi possano utilizzare al meglio la tua API.
Brenda Jin, Saurabh Sahni e Amir Shevat, Progettare API Web (O'Reilly, 2018)
Nel Capitolo 4 hai creato la tua prima API per soddisfare le user story identificate nel Capitolo 1. Gli utenti principali per cui le hai sviluppate sono gli utenti della scienza dei dati e i fornitori di siti web di consulenza. L'API consentirà loro di creare prodotti di analisi come dashboard, grafici e modelli utilizzando i dati delle fantasie di SportsWorldCentral (SWC). Ora dovrai creare la documentazione per aiutarli a utilizzare la tua API. La documentazione e le funzionalità come i kit di sviluppo software (SDK) migliorano l'esperienza dello sviluppatore (DX) per i tuoi utenti tecnici.
Trasmettere un segnale di fiducia
Un compito importante della tua documentazione API è quello di dare un segnale di fiducia ai potenziali utenti dell'API. Se non si fidano di te, non useranno la tua API. Se gli utenti dell'API intendono chiamare la tua API più volte, costruiranno un'integrazione, che in pratica è un codice che chiama il tuo codice ...