Swagger (spécification OpenAPI) – Perficient Blogs

NRZ.Digital
0 0

introduction

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’initiative OpenAPI 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 depuis Internet.

Dans cet article, nous montrerons comment utiliser la spécification d’API OAS 3.0 dans MuleSoft pour la conception, l’implémentation et la gestion d’API.

Aperçu

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 API OAS 3.0 existantes à partager avec les partenaires, les clients et les développeurs de la plate-forme ou dans les communautés 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.

Étapes du cycle de vie de l’API dans Anypoint Platform

OAS 3.0 est pris en charge par tous les produits d’Anypoint Platform pour les étapes du cycle de vie des API de conception, de publication et de gestion.

Étape du cycle de vie de l’APIProduitOAS 3.0 pris en charge ?Informations Complémentaires
ConceptionConcepteur d’APIOuiVous pouvez créer une spécification d’API OAS 3.0 ou importez-en une depuis Anypoint Exchange.
ConceptionStudio n’importe oùOuiVous pouvez importer une spécification d’API OAS 3.0 de Design Center en tant que projet de spécification d’API modifiable dans Studio. Vous pouvez aussi créer un projet de spécification d’API à partir de zéro dans Studio, puis synchronisez-le avec Design Center.
PublierÉchange n’importe oùOuiVous pouvez télécharger et publier une spécification OAS 3.0 et afficher la documentation de la spécification dans Exchange.
PublierGestionnaire de communauté d’API AnypointOuiVous pouvez publier une spécification OAS 3.0 et consultez la documentation de la spécification.
PublierREST ConnecterOuiVous 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.
Mettre en œuvreStudio n’importe oùOuiVous pouvez importer votre spécification API OAS 3.0 depuis Échange ou alors Maven et écrivez vos flux.
DéployerMoteur d’exécution MuleOuiOAS 3.0 est pris en charge dans le moteur d’exécution Mule.
FonctionnerGestionnaire d’APIOuiOAS 3.0 est pris en charge dans Gestionnaire d’API.

Conception d’OAS dans Anypoint Platform :

Il existe de nombreuses façons de créer/convertir l’OAS dans la plate-forme Anypoint à l’aide du centre de conception. Laissez-moi vous expliquer comment nous pouvons créer une nouvelle OAS dans le centre de conception.

  1. créant un nouveau projet de spécification d’API, sélectionnez OAS 3.0 dans le champ Langue.
  2. 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.
  3. Ou nous pouvons importer les spécifications OAS 3.0 existantes depuis Anypoint Exchange ou depuis votre système de fichiers
  4. Cliquez sur l’icône d’engrenage dans le coin supérieur droit de l’éditeur de texte.
  5. Sélectionnez l’une de ces options :
    1. Sélectionnez Importer depuis Exchange pour afficher ces deux listes :
      1. Une liste des spécifications d’API disponibles auprès de l’organisation commerciale à laquelle appartient votre ID utilisateur dans Anypoint Platform.
      2. Une liste des spécifications API publiées par MuleSoft
    2. Sélectionnez Importer pour importer une spécification d’API depuis votre système de fichiers local.
  6. Développer et éditer les spécifications OAS 3.0.
  7. Afficher la documentation
  8. Simulez des appels aux méthodes qui sont dans les spécifications de l’API OAS 3.0 en activant le service mocking.

Publier dans Anypoint Exchange :

Tout ce que nous avons créé dans le centre de conception, nous pouvons le publier sur Anypoint Exchange. Cliquez sur le bouton Publier dans le coin droit du projet dans Anypoint Design Center.

Sélectionnez la version et cliquez sur Publier sur Exchange.

Maintenant, nous pouvons aller échanger et voir le document API Design.

Implémenter dans Anypoint Studio :

Nous allons maintenant implémenter l’API à l’aide du document de conception OAS dans Anypoint Studio.

  1. Créez 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.
  2. nous cliquons sur terminer, nous devrions pouvoir voir les flux qui sont générés et nous pouvons faire notre logique métier par-dessus.

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.

http://localhost:8081/console/

Vous pouvez sélectionner la méthode GET et cliquer 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 le message Bad Request.

Gérer l’API dans Anypoint API Manager :

Vous trouverez ci-dessous les principaux types d’API OAS 3.0 dans API Manager :

  • Applications de point de terminaison de base pour Mule (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 d’API Manager.

  1. Dans 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.
  2. 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.

Ressources et références :

https://blogs.mulesoft.com/news/anypoint-platform/api-adoption-with-oas-3/

https://blogs.mulesoft.com/news/anypoint-platform/oas-3-0-full-api-lifecycle-support/

https://docs.mulesoft.com/release-notes/platform/oas3

A propos de l’auteur

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 les produits à temps.

Plus de cet auteur


Happy
Happy
0
Sad
Sad
0
Excited
Excited
0
Sleepy
Sleepy
0
Angry
Angry
0
Surprise
Surprise
0

Average Rating

5 Star
0%
4 Star
0%
3 Star
0%
2 Star
0%
1 Star
0%

Laisser un commentaire

Next Post

Comment la réalité augmentée dans les soins de santé est sur le point de transformer l'industrie à l'avenir

Comment la réalité augmentée est-elle définie pour transformer l’avenir des soins de santé ? La réalité augmentée dans le domaine de la santé est apparue comme l’une des technologies les plus passionnantes qui devrait se développer et transformer la médecine et la chirurgie. En 2020, la Réalité Augmentée a connu une […]

Abonnez-vous maintenant