Reusable Code : concevoir des API réutilisables en Javascript Les cinq éléments pour faire une bonne API

Produire du Javascript réutilisable : l'exemple de la BBC

Une excellente conférence, mais qui s'adresse essentiellement aux développeurs. L'orateur présente des bonnes pratiques pour réaliser des API réutilisables en Javascript. Bien sûr, bon nombre de conseils s'appliquent dans d'autres cas. C'est la deuxième conférence que j'ai suivi en anglais. Conférence dirigée par Jake Archibald, qui fait de belles aux APIs Javascript pour la BBC.

L'une de ses grosses missions, c'est de produire du Javascript réutilisable.

Il y a cinq éléments pour faire une bonne API :

 consistency
 flexibility
 readability
 writability
 Kinda useful-ability
 = Captain I build Reusable code? !

Tous les jours, avec les API, les risques de confusion sont nombreux

On va prendre l'exemple des Carrousel en JS, ils ont poussé comme des champignons ! Il y a des carousels partout sur le site de la BBC.

Une API est difficile à faire et difficile à changer

Bruce Wayne a dévoué sa vie à se battre contre le crime et c'est pour ça qu'il est devenu Batman. Jake a une histoire aussi : quand il était enfant, il voulait regarder un film documentaire avec sa mère. Il pensait que le documentaire en question était "Historical Fallacies". Il avait mal compris, le documentaire était en fait "Historical Phalluses", et il a subit le visionnage de ce documentaire avec sa mère.

Voilà, une démonstration qui montre que mal nommer quelque chose peut avoir des conséquences désastreuses : c'est difficile à lire, difficile à comprendre, et tout ça peut être source de confusions. Tous les jours, avec les API, les risques de confusion sont nombreux. Une API est difficile à faire et difficile à changer. Si elle est mal conçue, les gens ne vont pas savoir l'utiliser. Fort de cette expérience télévisuelle avec sa maman, Jake se devait de lutter contre les confusions, surtout dans son boulot. Mais passons à la pratique.