Ajout d'une API SOAP par importation d'un fichier zip

Vous pouvez utiliser un fichier de définition OpenAPI pour importer une API SOAP dans IBM® API Connect.

Avant de commencer

Le fichier doit être au format .zip et contenir la définition WSDL et le fichier YAML qui définit l'API. Le fichier YAML doit être conforme à la version 2.0 de la spécification OpenAPI .

Remarque: Les produits qui contiennent une API avec une propriété Swagger utilisant regex qui incluent des assertions lookahead, telles que "(?", ne peuvent pas être validés ou publiés. Un message d'erreur est renvoyé. Par exemple :
Product has not been published!
The multipart 'openapi' field contains an OpenAPI definition with validation errors.
    definitions.properties.pattern Does not match format 'regex' (context: (root).definitions.properties.pattern, line: 0, col: 0)
400

A propos de cette tâche

Vous pouvez effectuer cette tâche soit à l'aide de l'application d'interface utilisateur API Designer , soit à l'aide de l'interface utilisateur API Manager basée sur un navigateur.

Interface utilisateurAPI Manager uniquement: Pour effectuer cette tâche, vous devez disposer d'un rôle doté des droits Api-Drafts:Edit, Settings:Viewet App:View . Le rôle Développeur fourni au préalable dispose de ces droits par défaut ; si vous avez affecté un rôle personnalisé, il doit également avoir ces droits. Pour plus d'informations, voir Création de rôles personnalisés.

Si vous utilisez l'interface utilisateur d' API Designer et que vous souhaitez utiliser un fichier de définition OpenAPI depuis un autre emplacement, téléchargé à partir d'un site Web externe par exemple, au lieu d'être créé à l'aide de API Connect, utilisez le mécanisme d'importation décrit ici plutôt que de copier le fichier dans votre répertoire API Designer local ; l'opération d'importation ajoute des sections spécifiques à API Connect requises par API Designer.

Pour plus d'informations sur la création d'un fichier .zip , voir Téléchargement d'une définition d'API.

Procédure

Pour ajouter une API SOAP en important un fichier .zip, procédez comme suit :

  1. Dans le panneau de navigation, cliquez sur Icône de développement dans le panneau de navigation de l'interface utilisateur d'API Développement, puis sur Ajouter > API.
    L'écran Sélectionner le type d'API s'affiche.
  2. Sélectionnez OpenAPI 2.0
  3. Dans la section Importer, sélectionnez API ouverte existante, puis clique Suivant.
  4. Pour importer un fichier à partir de votre système de fichiers local, vous pouvez le faire glisser et le déposer ou cliquer sur le lien pour sélectionner le fichier à partir de votre système de fichiers local.
    L'assistant vérifie la validité de la définition WSDL et du fichier YAML, et affiche un message indiquant que la validation a abouti.
    Remarque :
    • Si vous utilisez l'interface utilisateur API Manager , l'opération d'importation échoue si le fichier définit une API ayant le même nom et la même version qu'une définition d'API existante. Toutefois, si vous utilisez l'interface utilisateur API Designer , les définitions d'API sont identifiées de manière unique par le nom de fichier dans votre système de fichiers local ; par conséquent, si vous importez deux fichiers différents qui définissent le même nom et la même version d'API, deux définitions d'API avec le même nom et la même version sont créées dans API Connect, sans erreur.
    • Les messages d'erreur de validation sont affichés en anglais uniquement et ne sont pas traduits.
  5. Cliquez sur Suivant.
  6. Facultatif: Sélectionnez Activer l'API si vous souhaitez utiliser immédiatement l'API à des fins de développement et de test.
    Remarque :
    • Lorsque vous sélectionnez l'option Activer l'API , API Connect effectue automatiquement les actions suivantes:
      • Crée un produit brouillon, ajoute l'API au produit et publie le produit dans le catalogue pour bac à sable afin que l'API soit disponible pour l'appel. Le produit porte le titre titre_api auto product. Ce produit n'est pas visible dans la vue Développement et vous ne pouvez pas le supprimer directement. Toutefois, si vous supprimez l'API, le produit brouillon est supprimé avec l'API ; voir Suppression d'une définition d'API. Le produit est visible dans tous les catalogues dans lesquels il est publié. Si vous souhaitez retirer le produit d'un catalogue, vous devez le faire séparément ; voir Retrait d'un produit d'un catalogue
      • Abonne l'application de test Bac à sable au produit afin que vous puissiez tester immédiatement l'API dans l'environnement de test. Pour plus d'informations sur le test d'une API, voir Test d'une API.
    • Vous ne pouvez pas utiliser l'option Activer l'API si l'approbation du cycle de vie est activée dans le catalogue pour bac à sable pour les actions de mise en préproduction, de publication ou de remplacement. Si des approbations de cycle de vie de ce type sont activées, pour pouvoir utiliser l'option Activer l'API , elles doivent être désactivées. Pour plus d'informations sur les paramètres d'approbation de cycle de vie, voir Création et configuration de catalogues.
    • Pour utiliser l'option Activer l'API , vous devez disposer d'un rôle disposant des droits Product:Manage et Subscription:Manage . Le rôle Développeur fourni au préalable dispose de ces droits par défaut ; si vous avez affecté un rôle personnalisé, il doit également avoir ces droits. Pour plus d'informations, voir Création de rôles personnalisés.
  7. Cliquez sur Suivant. Le panneau récapitulatif d'importation d'API indique que le fichier est chargé et valide.

    Si vous avez sélectionné Activer l'API, l'assistant renseigne une URL de noeud final d'API et affiche un ID client et une valeur confidentielle de client que vous pouvez utiliser.

  8. Sélectionnez l'une des options suivantes :
    • Pour configurer davantage votre API, cliquez sur Editer l'API. Pour plus de détails, voir Edition d'une définition d'API.
    • Si vous ne souhaitez pas configurer davantage votre API pour l'instant, cliquez sur le lien Développement dans le trajet de navigation pour revenir à la page d'accueil. Vous pouvez ensuite passer immédiatement à une autre tâche. Pour plus de détails sur la configuration de votre API ultérieurement, voir Edition d'une définition d'API.

Résultats

Lorsque la définition d'API a été importée, elle s'affiche dans la liste des définitions d'API dans la page Développement. Pour API Designer, les spécifications des API et des produits sont stockées dans le répertoire que vous avez spécifié lorsque vous vous êtes connecté. Pour API Manager, les spécifications des API et des produits sont stockées sur le serveur de gestion.

Etape suivante

Pour mettre les API à la disposition des développeurs d'applications, vous les incluez dans un produit que vous publiez dans un catalogue. Pour plus d'informations, voir Utilisation des produits et Utilisation des catalogues.