2010-02-21 9 views
0

Je dois souvent concevoir des API client à utiliser par d'autres programmeurs. La langue peut varier de Ruby, Java, Erlang et Javascript (Mootools). Est-ce que quelqu'un a des conseils sur la création d'une API très utilisable. Et oui, c'est "une" question très subjective et je demande que je puisse rendre mes API plus faciles à utiliser par d'autres.Quelle est la meilleure façon de concevoir une API client?

+0

Dupe: http://stackoverflow.com/questions/469161/how-do-you-define-a-good-or-bad-api – BalusC

+0

Merci, quand je entré la question, je n'ai pas vu l'autre. – Zubair

Répondre

1

montre ceci: http://video.google.com/videoplay?docid=-3733345136856180693#

Pour ajouter ce détail est une vidéo de conférence donnée par Josh Bloch qui est un BOD senior java à Google. C'est excellent si vous voulez un aperçu sur les questions à prendre en compte lors de la création d'une API

+0

Votre lien ne fonctionne pas, il est dit que la vidéo n'est pas disponible – Zubair

1

Quelques idées:

  • Faites vos noms de méthode très descriptive
  • Utilisez la documentation pour indiquer clairement les paramètres et les valeurs renvoyées
  • Suivez YAGNI et Kiss
  • Rien aide comme des exemples de code ... beaucoup d'entre eux couvrant beaucoup de cas d'utilisation
1

Si l'un des vos objectifs principaux est de faire un utilisable API, ou, en d'autres termes, pour fournir une bonne expérience de développeur , alors peut-être que vous devriez revoir cette liste de ressources (facilité d'utilisation api & ressources d'expérience de développeur): http://www.apiusabilitytesting.com/resources/

Questions connexes