Les spécifications Swagger/OpenAPI sont les meilleures pour la conception, la documentation et la gestion des API Restful. Depuis que MuleSoft a rejoint l'OpenAPI Initiative de la Linux Foundation, la plate-forme Anypoint de MuleSoft prend explicitement en charge Swagger/OAS pour la description des API. MuleSoft Design Center prend en charge l'importation d'une spécification OAS 3.0 au format JSON ou ZIP à partir du système de fichiers. Et nous pouvons importer une spécification OAS 3.0 à partir d'Internet.
Dans cet article, nous montrerons comment nous pouvons utiliser la spécification d'API OAS 3.0 dans MuleSoft pour la conception, l'implémentation et la gestion d'API.
Présentation
Nous pouvons concevoir, implémenter, déployer et exploiter des API à l'aide des formats natifs OpenAPI Specification (OAS) 3.0 dans Anypoint Platform. La prise en charge d'OAS 3.0 est incluse dans API Designer, Anypoint Studio, Anypoint Exchange, API Manager et Anypoint API Community Manager.
Nous pouvons cataloguer les spécifications d'API OAS 3.0 existantes à partager avec les partenaires, les clients et les développeurs sur la plate-forme ou dans communautés d'API internes et externes. Et nous pouvons gérer et sécuriser vos API OAS 3.0 en appliquant des politiques appropriées.
Je montrerai dans cet article comment nous pouvons concevoir la spécification OpenAPI dans Anypoint Platform, publier pour échanger et gérer l'API dans API Manager.
Les étapes du cycle de vie de l'API dans Anypoint Platform
OAS 3.0 sont prises en charge par tous les produits dans Anypoint Platform pour les étapes du cycle de vie de l'API : conception, publication et gestion.
API Lifecycle Stage
Product
OAS 3.0 Pris en charge ?
Informations supplémentaires
Design
API Designer
Oui
Vous pouvez créer une spécification API OAS 3.0 ou en importer une depuis Anypoint Exchange.
Vous pouvez télécharger et publier une spécification OAS 3.0 et afficher la documentation de la spécification dans Exchange.
Publier
Anypoint API Community Manager
Oui
Vous pouvez publier une spécification OAS 3.0 et afficher la documentation des spécifications.
Publier
REST Connect
Oui
Vous pouvez publier une spécification OAS 3.0 mais lorsqu'un connecteur ne peut pas être généré à partir de la spécification API, un e-mail est envoyé à l'utilisateur , expliquant la cause de l'erreur.
Implement
Anypoint Studio
Yes
Vous pouvez importer votre spécification API OAS 3.0 depuis Exchange ou Maven et écrire vos flux.
Déployer
Mule runti me engine
Oui
OAS 3.0 est pris en charge dans le moteur d'exécution Mule.
Operate
API Manager
Yes
OAS 3.0 est pris en charge dans API Manager.[19659047]Concevoir l'OAS sur la plate-forme Anypoint :
Il existe de nombreuses façons de créer/convertir l'OAS sur la plate-forme Anypoint à l'aide du centre de conception. Laissez-moi vous expliquer comment nous pouvons créer un nouvel OAS dans le centre de conception.
Créant un nouveau projet de spécification d'API, sélectionnez OAS 3.0 dans le champ Langue.
Modifiez le contact OAS 3.0 en fonction de vos exigences API. Nous pouvons créer des spécifications au format JSON, YAML. J'ai créé une spécification d'API de contacts dans le centre de conception.
Ou nous pouvons importer les spécifications OAS 3.0 existantes depuis Anypoint Exchange ou depuis votre système de fichiers
Cliquez sur l'icône d'engrenage dans le coin supérieur droit de l'éditeur de texte.
Sélectionnez l'une de ces options :
Sélectionnez Importer depuis Exchange pour afficher ces deux listes :
Une liste des spécifications d'API disponibles auprès de l'organisation commerciale à laquelle appartient votre ID utilisateur dans Anypoint Platform.
Une liste des spécifications d'API publiées par MuleSoft
Sélectionnez Importer pour importer une spécification d'API depuis votre système de fichiers local.
Développer et modifier les spécifications OAS 3.0.
Afficher la documentation
Simuler les appels aux méthodes qui sont dans les spécifications de l'API OAS 3.0 en activant le service de moquerie.
Publier dans Anypoint Exchange :
Quelque soit nous avons créé dans le centre de conception que nous pouvons publier sur Anypoint Exchange. Cliquez sur le bouton Publier dans le coin droit du projet dans le centre de conception Anypoint.
Pour garantir que votre implémentation ou migration Salesforce se déroule comme prévu, notre équipe de professionnels de la gestion du changement discute comment gérer le processus de transition pour vous assurer que votre équipe est prête, disposée et capable de fonctionner efficacement dans le nouvel environnement.
Sélectionnez la version et cliquez sur Publier sur Exchange.
Nous pouvons maintenant allez à l'échange et consultez le document de conception d'API.
Implémentation dans Anypoint Studio :
Nous allons maintenant implémenter l'API à l'aide du document de conception OAS dans Anypoint Studio.
Créer un projet Mule dans Anypoint Studio. Entrez le nom du projet et importez une API publiée en recherchant l'API que nous avons publiée en échange à l'étape ci-dessus.
nous cliquons sur terminer, nous devrions pouvoir voir les flux qui sont générés et nous pouvons faire notre logique métier en plus de it.
Déployez l'application et testez :
Dans les étapes ci-dessus, nous avons implémenté une API Mulesoft qui a généré des flux de base à l'aide du document de conception OAS. Nous pouvons maintenant déployer l'application dans le gestionnaire d'exécution et la tester.
Cliquez avec le bouton droit sur le projet dans Anypoint Studio et sélectionnez Exécuter en tant qu'application Mulesoft. Il sera déployé dans le runtime Mulesoft. Comme cette application a des méthodes GET, POST avec le nom de la ressource de contacts, nous pouvons tester à l'aide de la console API en utilisant l'URL ci-dessous.
Vous pouvez sélectionner la méthode GET et cliquez sur le bouton Envoyer. Nous devrions pouvoir voir le code d'état 200 avec la réponse.
Vous pouvez supprimer le prénom de la demande et cliquer sur Envoyer dans la méthode POST. Il renverra le code d'état 400 avec un message de demande incorrecte.
Gérer l'API dans Anypoint API Manager :
Vous trouverez ci-dessous les principaux types d'API OAS 3.0 dans API Manager :
Basic Endpoint for Mule applications (rappels non pris en charge)
Point de terminaison de base pour les applications non Mule
Point de terminaison avec proxy (rappels non pris en charge)
Nous pouvons gérer vos API OAS 3.0 en créant des versions et des instances et en appliquant des politiques à partir du gestionnaire d'API.
Dans l'API Manager, cliquez sur Gérer l'API et sélectionnez Gérer l'API depuis Exchange. Recherchez le nom de l'API et sélectionnez l'API appropriée.
Toutes les valeurs seront renseignées automatiquement. Sélectionnez la version Mule et cliquez sur Enregistrer.
Nous pouvons appliquer les politiques par-dessus et nous pouvons gérer cette API selon nos besoins.
Contactez-nous pour en savoir plus sur ce que vous pouvez faire avec MuleSoft.
Meron est consultant technique senior chez Perficient. Elle possède une vaste expérience dans l'intégration, la conception et la mise en œuvre d'applications à l'aide de Mulesoft. Meron fait partie de plusieurs implémentations Mulesoft et aide les clients à livrer leurs produits à temps.
