Implémentation d’une interface Open Data avec Drupal 9

Une interface Open Data permet de fournir les données les plus récentes à des systèmes externes. Il y a peu, nous avons développé la nouvelle interface Open Data pour Zürich Tourismus dans Drupal 9.

Le déploiement a eu lieu après une migration de données complexes et l’implémentation de nombreuses fonctions spécifiques au client. Le nouveau site web de Zürich Tourismus a été mis en ligne début 2021. Il reposait alors sur la première version d’une interface Open Data, qui permet aux partenaires de recourir à des données actuelles depuis le site web.

Conception de l’interface dans Drupal 9

L’interface fonctionnait avec Drupal 7, mais allait devoir faire ses adieux. Les exigences du client étaient claires : l’interface devait être reproduite le plus fidèlement possible et implémentée dans Drupal 9 au lieu de Drupal 7. La structure des données doit soutenir Schema.org, raison pour laquelle l’interface dans Drupal 7 avait été développée sur mesure pour Zürich Tourismus.

Nous voulions utiliser le plus possible de fonctions de la communauté Drupal pour le développement de la nouvelle interface Open Data. Cela contribue à garantir la maintenabilité et la qualité, mais fait aussi gagner du temps.

Il existe plusieurs approches pour construire une telle interface. Et comme souvent, chacune a ses avantages et ses inconvénients.

Approche 1 : utilisation de modules de normalisation existants

Drupal propose plusieurs modules qui satisfont déjà de telles exigences, par exemple le module core JSON:API. Ces modules sont implémentés de manière très générique. Si possible, tous les champs des entités sont normalisés. Par contre, si l’on a besoin d’une toute autre structure ou d’une logique supplémentaire pour certains champs, il faudra investir dans des ajustements. Notons aussi que ces modules proposent souvent bien plus de fonctions que nécessaire. La souplesse en souffre et toutes ces fonctions qui ne sont pas utilisées ne sont pas non plus propices à une bonne vue d’ensemble.

Approche 2 : une normalisation sur mesure, combinée au module RESTful Web Services

Le [module RESTful Web Services] est lui aussi un module core de Drupal(https://www.drupal.org/docs/8/core/modules/rest). Grâce à lui, intégrer des interfaces REST à un projet Drupal est un vrai jeu d’enfant. Du fait qu’il faut se charger soi-même de toute la normalisation, on ne peut pas en dire autant de l’implémentation de l’interface Open Data avec ce module. Par contre, on profite d’une grande souplesse. Il est donc plus aisé d’obtenir une implémentation claire et durable.

Réalisation

Nous parvenons à la normalisation à l’aide d’une classe de normalisateurs qui transforme les entités Drupal dans les classes de modèles que nous avons créées. Ces classes représentent les types de Schema.org. Le graphique ci-après illustre ce processus à l’aide d’une entité du type de node place. Ici, le type de modèle correspond à LocalBusiness.

Le recours à ces modèles permet de séparer l’affectation et la transformation. Une fonction toArray sur la classe de modèle permet de contrôler entièrement la mise en série des données.

L’interface Open Data en action

Les partenaires peuvent relier l’interface Open Data à un client compatible REST et ainsi synchroniser leurs données.

La page de vue d’ensemble sur https://www.zuerich.com/en/data comporte des catégories de lieux et de possibilités d’hébergement. Pour inclure tous les restaurants de zuerich.com, on indique l’identité de la catégorie par un paramètre de requête.

https://www.zuerich.com/en/data?id=74

L’hôtel Schweizerhof Zürich tire ses données de cette manière pour la page https://www.hotelschweizerhof.com/en/concierge-service/gastronomy.