#devoxxfr – L’Expérience Développeur et votre API

Et comment on fait de belles api alors ?
Evidement, ce talk parle d’apis rest/http. Mais à mon avis, ça peut se projeter sur d’autres domaines comme les interfaces entre modules (quels qu’ils soient).

Première chose à envisager : quels sont les utilisateurs ?

Donc d’abord, rendre l’api compréhensible.

Et rendre la documentation « inutile » : proposer des exemples de code, faire des guides d’utilisation (des howto, typiquement), et avoir un exemple complet d’utilisation. Toute cette documentation, écrivez-la avec des outils « connus ».
Permettre aux utilisateurs de contribuer de la doc est également une bonne façon de créer de la documentation facilement.

Laisser un commentaire

Entrez vos coordonnées ci-dessous ou cliquez sur une icône pour vous connecter:

Logo WordPress.com

Vous commentez à l'aide de votre compte WordPress.com. Déconnexion / Changer )

Image Twitter

Vous commentez à l'aide de votre compte Twitter. Déconnexion / Changer )

Photo Facebook

Vous commentez à l'aide de votre compte Facebook. Déconnexion / Changer )

Photo Google+

Vous commentez à l'aide de votre compte Google+. Déconnexion / Changer )

Connexion à %s