DC2009 : Building API that Rock

0Jérémy • 5th Mar 2009 • Web development • dc2009, drupal

Je vous livre un petit résumé de ma journée d’hier au Drupal Con 2009 de Washington.

Building API that rock

La session était présentée par eaton, l’auteur de quelques tout petit modules Drupal un brain populaires :

• Token
• VotingAPI
• Form API
• Twitter API
• Amazon API
• Render API

Eaton nous expliquait qu’il est primodial de construire une API selon le principe : “répondre aux besoins les plus simples”. Ainsi une API doit fournir un ensemble de fonctions suffisemment générique pour que les modules reposant sur cette API puissent ajouter leur couche “métier”. Il nous prenait ainsi comme exemple sa première version de VotingAPI qui n’était composée que de 2 fonctions :

• votingapi_set_vote()
• votingapi_get_vote()

Si on s’attache à la construction du nom de ses fonctions, celles-ci répondent à 2 concepts :

• data : la donnée manipulée sous forme de nom, un “vote”
• action : l’action produite par la fonction sous forme de verbe, “set” et “get”

A partir de ces deux fonctions élémentaires, on peut ajouter de la flexibilité, Eaton a donc ajouté les fonctions suivantes :

• votingapi_add_vote()
• votingapi_change_vote()
• votingapi_delete_vote()

Il est deplus indispensable d’utiliser au maximum les hooks Drupal ainsi que la fonction drupal_alter() pour permettre aux autres modules d’intéragir sur les données avant que votre API n’enregistre les données en base. A noter lors de l’utilisation de la fonction drupal_alter(), il est impératif de passer les variables par référence (&$variable).

Enfin pour les grandes lignes :

• le moins de dépendances possibles
• attention au cron, il n’y a pas de $user accessible

C’est un peu en vrac, mais l’idée est là !

No related posts.

Related posts brought to you by Yet Another Related Posts Plugin.