API Platform (beta) : le framework web PHP nouvelle génération (partie 3)

Troisième et dernière partie du tutoriel consacré à API Platform, le framework PHP développé par notre gérant Kévin Dunglas et auquel nous contribuons activement. Cet article est toujours disponible en version anglaise.

Prérequis : Node.js et NPM doivent être installés.

Dunglas’ API Platform est indépendant de toute technologie côté client. Vous pouvez utiliser la plate-forme, le langage ou le framework de votre choix. Pour illustrer les portes qu’ouvre l’adoption d’une architecture API-first et la facilité de développement d’une application monopage, nous allons créer un petit client AngularJS.

Gardez à l’esprit qu’il ne s’agit pas d’un tutoriel AngularJS et que je ne prétends pas suivre les bonnes pratiques AngularJS. Il s’agit juste d’un exemple visant à montrer à quel point le développement d’applications devient simple lorsque toute la logique métier est encapsulée dans une API. La seule responsabilité de notre client de blog AngularJS est d’afficher les informations récupérées par l’API (couche présentation).

L’application AngularJS est totalement indépendante de l’API. C’est une application HTML/JS/CSS qui interroge une API via AJAX. Elle a son propre dépôt Git et est hébergée sur son propre serveur web. Puisqu’elle ne contient que des assets, elle peut même être hébergée directement sur un Content Delivery Network comme Amazon CloudFront ou Akamai (nous hébergeons la démo sur GitHub Pages).

Pour échafauder notre application AngularJS, nous allons utiliser le générateur Angular officiel de Yeoman. Installez le générateur puis générez un squelette de client :

Yeoman vous posera des questions. Nous voulons que l’application reste minimale :

Toutefois, nous allons installer Restangular, un super client REST pour Angular qui s’intègre bien à API Platform :

Le générateur Angular est accompagné de l’outil de build Grunt. Il compile les assets (réduction, compression) et peut exposer la web app via son serveur intégré. D’ailleurs, lancez-le.

DunglasApiBundle fournit dans sa documentation un guide d’intégration Restangular. Une fois configuré, Restangular va fonctionner avec l’API JSON-LD/Hydra comme avec n’importe quelle autre API REST classique.

Ensuite, modifiez le fichier app/app.js pour enregistrer Restangular et le configurer correctement :

Prenez soin de changer l’URL de base avec celle de votre API en production (PROTIP : utilisez grunt-ng-constant).

Et voici le contrôleur qui récupère la liste des articles et nous permet d’en créer une nouvelle :

Comme vous pouvez le voir, il est très facile d’interroger l’API avec Restangular. La bibliothèque émet automatiquement des requêtes HTTP au serveur et hydrate des objets JavaScript “magiques” correspondant aux réponses JSON qui peuvent être manipulés pour modifier les ressources distantes (via des requêtes PUT, POST et DELETE).

Nous tirons également parti de la gestion des erreurs côté serveur pour afficher de jolis messages quand les données soumises sont invalides ou lorsque quelque chose ne va pas.

Et la vue correspondante bouclant sur les publications et affichant le formulaire et les erreurs :

C’est la fin de ce tutoriel ! Notre client blog est prêt et il fonctionne ! Vous vous souvenez de l’ancienne façon de créer des applications web synchrones ? Que pensez-vous de cette nouvelle approche ? C’est plus simple et beaucoup plus puissant, vous ne trouvez pas ?

Bien entendu, il reste encore pas mal de boulot afin d’obtenir un client fini incluant le routing, le support de la pagination et permettant d’intégrer du JSON-LD brut dans le HTML généré pour les moteurs de recherche (utilisez le hook Response Extractor fourni par Restangular).  Dans la mesure où il s’agit uniquement de tâches Angular, cela dépasse le cadre de cette introduction à API Platform. Ajouter de telles fonctionnalités au client est néanmoins un bon exercice. N’hésitez pas à partager vos snippets dans les commentaires.

La facilité de développement et de la puissance d’API Platform vous ont convaincu ? Donnez-nous votre feedback dans les commentaires !

La première bêta est prête et il y a des tâches à accomplir avant la première version stable :

J’espère publier la première version stable très prochainement. Vous pouvez m’y aider en contribuant (rapports de bug, documentation, code). Tout est hébergé sur GitHub et les Pull Requests sont les bienvenues.

Je remercie tout spécialement Samuel Roze (ancien membre de l’équipe de Les-Tilleuls.coop et aujourd’hui employé chez Inviqa), Théo Fidry et Fabien Gasser (Smile), Maxime Steinhausser, Jérémy Derussé et Luc Vieillescazes (SensioLabs) ainsi que Michaël Labrut (La Fourchette) d’avoir contribué au projet en y apportant du code, de la documentation et une tonne de bonnes idées.

API Platform n’aurait jamais vu le jour sans les formidables technologies et bibliothèques qu’il utilise comme bases, particulièrement Symfony, Doctrine, JSON-LD, Hydra et Schema.org. Un grand merci à tous leurs contributeurs.

Vous avez peur d’essayer ce nouveau framework ? Le support commercial est déjà disponible : Les-Tilleuls.coop est en mesure de développer vos logiciels basés sur API Platform (et Symfony). Notre équipe d’ingénieurs expérimentés propose des prestations de formation et de consulting. N'hésitez pas à nous contacter pour en savoir plus !