Exportation de votre flux API en tant que document OpenAPI

À partir de App Connect Designer, vous pouvez exporter votre flux API sous la forme d'un document OpenAPI qui définit toutes les ressources et opérations de l'API REST.

A propos de cette tâche

Lorsque vous exportez la définition de l'API, vous pouvez choisir un format YAML ou JSON conforme à la version de la spécification OpenAPI 2.0 ou à la version de la spécification OpenAPI 3.0.

Vous pouvez utiliser le document exporté OpenAPI de la manière suivante.
  • Vous pouvez importer le document dans un outil de gestion d'API ou un client REST de votre choix. Par exemple, vous pouvez importer le document OpenAPI dans IBM® API Connect pour continuer à développer et à tester l'API. Vous pouvez ensuite publier l'API (vers un produit dans un catalogue) et la diffuser.
  • Vous pouvez partager la définition de l'API avec d'autres utilisateurs.
  • Vous pouvez ajouter le document en tant qu'API importée dans App Connect Designer à partir de la page Applications et API. Pour plus d'informations, voir Comment utiliser IBM App Connect avec des API importées de documents OpenAPI.
  • Vous pouvez ajouter le document OpenAPI à un système de contrôle des sources à des fins de sauvegarde.

Procédure

Pour exporter un flux sous la forme d'un document OpenAPI, procédez comme suit.

  1. Sur la page App Connect Conception Concevoir l'icône de la page, localisez le flux API, ouvrez son menu, puis cliquez sur Exporter.
    Le flux peut être à l'arrêt ou en cours d'exécution.
    Option d'exportation dans le menu de flux
  2. Dans le panneau Exportation, choisissez la syntaxe que vous préférez pour le document OpenAPI.
    • Cliquez sur OpenAPI V3.0 (YAML ) pour exporter le flux dans un format YAML conforme à la version OpenAPI de la spécification 3.0.
      Conseil : vous pouvez également utiliser l'option OpenAPI V3 YAML and Runtime flow BAR assets (ZIP) pour exporter le flux dans un format YAML conforme à la version OpenAPI de la spécification 3.0. Cette option vous permet d'obtenir un fichier compressé contenant le document OpenAPI et un fichier BAR.
    • Cliquez sur OpenAPI V3.0 (JSON ) pour exporter le flux dans un format JSON conforme à la version OpenAPI de la spécification 3.0.
    • Cliquez sur OpenAPI V2.0/Swagger document (YAML ) pour exporter le flux dans un format YAML conforme à la version OpenAPI de la spécification 2.0.
    • Cliquez sur OpenAPI V2.0/Swagger document (JSON ) pour exporter le flux dans un format JSON conforme à la version OpenAPI de la spécification 2.0.
    Panneau d'exportation
  3. Cliquez sur Exporter.
  4. Si vous y êtes invité, enregistrez le fichier, qui porte par défaut le nom de votre flux, sous flowName-openapi.yaml ou flowName-openapi.json.
    En fonction de votre navigateur, le fichier peut être automatiquement téléchargé vers un emplacement de téléchargement configuré.
    Note : Si vous avez choisi d'exporter dans un format YAML ou JSON conforme à la spécification OpenAPI Version 3.0, les résultats suivants s'appliquent.
    • Si les conditions de la rédaction unifiée sont remplies à la fois dans App Connect Designer et dans API Connect le document exporté OpenAPI comprend certaines extensions qui s'appliquent à API Connect. La première extension est un paramètre x-ibm-name dans la section info . L'autre extension est une section x-ibm-configuration avec la définition de la politique qui est configurée dans la vue Politiques de l'onglet Passerelle dans votre instance du Designer.

      (Vous pouvez utiliser la fonction de création unifiée pour exposer simultanément votre API à la fois dans App Connect Designer et dans API Connect comme décrit dans la section Création de flux pour une API à partir de zéro )

    • Si vous avez exporté un flux en cours d'exécution, le point de terminaison URL de l'API en cours d'exécution est inclus dans une section servers du document OpenAPI exporté. Si les conditions de la fonction de rédaction unifiée sont remplies, le point de terminaison de l'API est fourni par le service de passerelle dans la section API Connect. Dans le cas contraire, ce point d'accès est fourni par App Connect Designer.

      La section servers est omise pour les flux qui sont en état d'arrêt.

    Conseil : pendant que vous testez un flux en cours d'exécution, vous pouvez également télécharger le document OpenAPI, qui décrit l'API. Allez dans l'onglet Test et trouvez le lien de téléchargement sur la page de présentation. Pour plus d'informations, voir Test des flux pendant le développement.