Qu’est-ce qu’OpenAPI et pourquoi l’utiliser ?
OpenAPI définit une description d’interface standard et indépendante du langage de programmation pour les API web. Il permet aux humains et aux ordinateurs de découvrir et comprendre les fonctionnalités d’un service sans devoir accéder au code source ou à d’autres documents ni inspecter le trafic réseau.
Le consommateur peut comprendre une API web et communiquer avec elle en un minimum d’efforts, grâce à un document OpenAPI qui la décrit.
Un connecteur personnalisé peut être créé pour toute API web à condition qu’il soit correctement décrit par un document OpenAPI. Autrement dit, l’équipe de développement Fusion de VanArsdel n’est pas limitée à la création de connecteurs personnalisés pour ses applications Power Apps à partir d’API web hébergées dans Gestion des API Azure.
À quoi sert un document OpenAPI ?
Le document OpenAPI spécifie un contrat du périmètre de l’API web. Il soustrait le consommateur de l’API aux spécificités de mise en œuvre réelle. Autrement dit, vous pouvez rapidement créer votre application en sachant quelles méthodes appeler et ce qu’elles renvoient sans avoir à vous soucier de la façon dont elles sont appelées.
Dans l’unité précédente, vous avez créé un connecteur personnalisé à l’aide de Gestion des API Azure. Ce faisant, vous avez également créé une dépendance sur Gestion des API Azure. En d’autres termes, si une modification se produit sur Gestion des API Azure, votre connecteur personnalisé doit être mis à jour pour refléter cette modification.
Avec le document OpenAPI, vous n’avez pas besoin de savoir où se trouve l’API ni si elle est en cours d’exécution, car le document contient toutes les informations nécessaires.
Power Apps vous permet de créer instantanément un connecteur personnalisé à l’aide de ce document OpenAPI.
Après avoir créé le connecteur personnalisé à partir du document OpenAPI, vous pouvez l’afficher sur votre page Power Apps.
Pourquoi créer un connecteur personnalisé à l’aide d’un document OpenAPI ?
La création de votre connecteur personnalisé à l’aide d’un document OpenAPI présente de nombreux avantages. Mais pour les développeurs citoyens, les deux plus importants sont les suivants :
- Supprimer les dépendances : avec un document OpenAPI, vous pouvez créer vous-même un connecteur personnalisé, sans attendre que quelqu’un en crée un pour vous à partir de Gestion des API. De plus, il est de plus en plus courant que les équipes de développement professionnel intègrent des fonctionnalités de génération de documents OpenAPI dans l’API web elle-même. Autrement dit, vous pouvez télécharger le document OpenAPI en visitant une URL, puis créer le connecteur personnalisé avec.
- Gagner en agilité : la cadence de développement de votre Power App augmente lorsque votre équipe de développement d’API web peut vous remettre un document OpenAPI. Vous n’avez pas besoin de compter sur elle pour créer et utiliser un connecteur personnalisé.
Comme illustré dans le schéma suivant, le document OpenAPI n’a pas besoin de connaître l’implémentation réelle de l’API web, du moment que le contrat reste le même.
Connecteur personnalisé à partir d’un document OpenAPI ou de Gestion des API Azure
Vous pouvez créer un connecteur personnalisé à l’aide de Gestion des API Azure ou d’un document OpenAPI. Lequel devriez-vous choisir ?
Ce tableau établit un comparatif entre Gestion des API Azure et OpenAPI en matière de connecteurs personnalisés.
| Connecteur | Gestion des API Azure | Document OpenAPI |
|---|---|---|
| Contrôle API | Centralisé | Distribué |
| Couche de structure de l’API | Complexe | Simple |
| Couche de sécurité supplémentaire | Oui | Non |
| Contrôle d’utilisation | Oui | Non |
| Coût supplémentaire | Oui | Non |
| Complexité architecturale | Supérieure | Inférieure |