Ajout d'une API REST en important un fichier de définition OpenAPI

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

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

Pour ajouter une API REST en important un fichier OpenAPI , procédez comme suit:

1. Dans le panneau de navigation, cliquez sur Développement, puis sur Ajouter > API.
   L'écran Sélectionner le type d'API s'affiche.
2. Sélectionnez OpenAPI 2.0 ou OpenAPI 3.0 en fonction de la version de la spécification OpenAPI sur laquelle votre API doit être basée.
3. Dans la section Importer, sélectionnez API ouverte existante, puis clique Suivant.
4. Choisissez l'une des méthodes suivantes pour importer le fichier:
   • Transfert de fichier par glisser-déposer

     Ouvrez une autre fenêtre, sélectionnez un fichier. Faites glisser le fichier dans la zone Sélectionner un fichier et libérez le fichier.

   • Rechercher un fichier

     Cochez la case Sélectionner un fichier . Localisez le fichier et sélectionnez-le.

   • Spécifier l'adresse URL d'un fichier

     Dans le champ Ou spécifiez un fichier URL, tapez ou collez un URL pour le fichier. Vous pouvez éventuellement ajouter un nom d'utilisateur et un mot de passe s'ils sont requis pour accéder au fichier.

   Les types de fichier suivants sont pris en charge s'ils contiennent une définition OpenAPI valide: .json, .ymlet .yaml.
5. Cliquez sur Suivant pour importer le fichier sélectionné.

   L'assistant vérifie la validité du fichier YAML et affiche un message indiquant que la validation a abouti.

   Remarques :

   • 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.
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 Import API Summary indique que le fichier YAML 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.