Contrats d'API

Chaque micro-frontend est un système capable d'encapsuler les opinions, la logique et la complexité. Les préoccupations transversales incluent généralement les suivantes :

• Systèmes de conception ‒ Outillage pour le développement UIs distribué sous forme de bibliothèques

• Composition ‒ La façon dont un micro-frontend doit interagir avec le shell d'une application pour afficher et hériter de son contexte

• Gestion logique ‒ Interaction avec APIs pour gérer l'état persistant

• Interactivité avec d'autres micro-frontends ‒ Scénarios tels que la publication et la consommation d'événements ou la navigation d'un micro-frontend à un autre

Pour accélérer la consommation et le dépannage, il est courant d'investir dans la standardisation de la manière dont ces interfaces sont déclarées et documentées, y compris les dépendances des micro-frontend. Les wikis créés par des humains sont un bon début. Une approche plus évolutive consiste à stocker ces informations sous forme de métadonnées structurées dans le code. Vous pouvez ensuite le centraliser pour la consommation en utilisant l'automatisation pour suivre les modifications historiques et fournir une recherche en texte intégral.

Lorsque les micro-frontends impliquent un grand nombre d'équipes, vous avez besoin d'une stratégie de coordination entre les équipes. Le partage unifié des contrats d'API devient indispensable car il réduit les frais de communication et améliore l'expérience des développeurs.

OpenAPI est un langage de spécification pour HTTP APIs qui permet de définir des interfaces API et des contrats de manière unifiée. Vous pouvez implémenter REST APIs à l'aide d'OpenAPI dans Amazon API Gateway. Vous pouvez également utiliser une grande variété de frameworks open source que vous pouvez héberger dans des conteneurs ou des machines virtuelles. Un avantage significatif est qu'OpenAPI peut générer automatiquement de la documentation dans un format cohérent, ce qui permet à plusieurs équipes de partager leurs connaissances avec un investissement initial minimal.

Lorsque plusieurs équipes travaillent sur des micro-frontends, elles forment souvent des groupes. Dans ces groupes, les gens peuvent se rencontrer et apprendre les uns des autres tout en réfléchissant et en contribuant à la vision d'ensemble. Ces initiatives définissent et documentent généralement les limites de propriété, discutent des préoccupations transversales et identifient dès le début toute duplication des efforts pour résoudre des problèmes communs.