Il est temps de construire une API (si vous n'en êtes pas là, relisez le début de la phrase : Il est temps de construire une API).
Le problème c'est qu'une fois publiée, l'API est utilisée. Ce que vous construisez est là pour longtemps. Quelles sont les retours d'expériences et bonnes pratiques pour ne pas se prendre les pieds dans le tapis ?
Vous avez certainement déjà entendu parler de REST mais les choses sont plus complexes que ça. Comment gérer les évolutions et les versions de l'API ? les formats en entrée et en sortie ? les variations et paramètres d'une même ressources ? les relations entre ressources ? la sécurité ? l'authentification ? la gestion des erreurs ? la pagination ? l'i18n et l10n ?
Plus généralement, vous objectifs principaux sont de définir une API simple et basique (si vous pensez avoir d'autres objectifs relisez le début de la phrase).
Nous allons parler de tout ça, autant sur le mode théorie que retour d'expérience pratique.