Mise en préproduction d'un produit brouillon

Modifier en ligne

Ajoutez un brouillon du produit à un catalogue afin de créer une version spécifique de ce produit avant sa publication. Lorsqu'un produit est à l'état mis en préproduction, il n'est pas encore visible par les développeurs, ni abonné par eux.. La fonction de syndication dans IBM® API Connect signifie que si des espaces sont activés pour un catalogue, les produits ne peuvent être mis en préproduction que dans un espace de ce catalogue.

Avant de commencer

Vérifiez que vous disposez d'un catalogue dans lequel effectuer la mise en préproduction dans les interfaces utilisateur API Manager ou API Designer . Pour plus d'informations, voir Création et configuration de catalogues.
Remarque: Toutes les références dans cette rubrique à un catalogue peuvent également être appliquées à des espaces dans un catalogue, sauf indication contraire. Pour plus d'informations sur les espaces, consultez la section « Utilisation de la syndication » dans API Connect.

Pour exécuter les tâches de gestion de produit décrites dans cette rubrique, vous devez être propriétaire de l'organisation de type fournisseur d'API ou disposer du droit Produit > Mettre en préproduction pour le catalogue cible ou l' espace. Pour plus d'informations sur la configuration des droits de gestion de produit pour un catalogue ou un Espace, voir Création et configuration de catalogues ou Gestion de l'accès utilisateur dans un espace.

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.

La mise en scène n'est pas disponible lorsque vous travaillez hors ligne dans API Designer.

Un catalogue est une cible de transit et fonctionne comme une partition logique de l' DataPower® Gateway, et du Consumer Catalog.

Vous mettez un produit en attente afin que les autorisations nécessaires puissent être accordées en interne et que le produit puisse être publié. Pour plus d'informations sur la configuration des validations du cycle de vie des produits pour un catalogue, consultez la section Création et configuration des catalogues. Pour plus d'informations sur l'approbation des demandes, consultez la section « Approuver les demandes relatives au cycle de vie des produits et aux abonnements ». Pour plus d'informations sur la publication d'un produit, consultez la section « Publication d'un produit ».

Vous ne pouvez pas réintégrer une version existante d'un produit dans un catalogue de production. Si vous mettez à jour une API, vous devez en créer une nouvelle version. Ensuite, vous devez créer une nouvelle version du produit afin qu'il inclue la version la plus récente de l'API. Pour plus d'informations sur la création de nouvelles versions d'API et de produits, consultez les sections Créer une nouvelle version d'une définition d'API et Créer une nouvelle version de votre produit. Si les espaces sont activés dans un catalogue de production, vous ne pouvez pas réintégrer la même version d'API ou de produit dans un espace quelconque de ce catalogue. Vous pouvez toutefois replacer une version de produit dans le catalogue de test ou dans un autre catalogue hors production afin de faciliter les tests itératifs.
Remarque : lorsque vous transférez une version de produit vers un catalogue hors production, les abonnements à l'application existants sont supprimés. Les abonnements sont supprimés afin de faciliter le déploiement automatisé dans un environnement d'intégration continue, où la recréation des abonnements d'application sera gérée par des scripts.
Si les espaces sont activés dans un catalogue hors production et que vous transférez une version de produit vers un espace différent de celui dans lequel elle était précédemment stockée, celle-ci est supprimée de l 'espace précédent et transférée vers le nouvel espace spécifié. Si l'intégration de facturation est activée dans un produit, vous ne pouvez pas remettre en préproduction la même version de produit dans un catalogue en production ou hors production. Pour plus d'informations sur l'intégration de la facturation, voir Monétisation de vos produits.
La validation du fichier de définition d'API a lieu lors du processus de transfert ou de publication. Les validations suivantes sont effectuées :
  • Validation par rapport au schéma OpenAPI à l'aide de l'analyseur Swagger API Dev Tools (https://www.npmjs.com/package/@apidevtools/swagger-parser).
  • Validation par rapport aux propriétés d'extension IBM .
  • Validation sémantique, avec notamment les types de validation suivants :
    • Garantir que si une OpenAPI est appliquée par une passerelle API Connect, le schéma doit être HTTPS, ou le nom du paramètre pour un schéma de sécurité de clé API dans l'en-tête doit être soit X-IBM-Client-Id soit X-IBM-Client-Secret.
    • Si OpenAPI n'est pas appliqué par un API Connect Passerelle, un hôte doit être fourni.
    • Le déréférencement des références locales dans le fichier de définition (c'est-à-dire les valeurs des propriétés $ref ) et la vérification qu'il s'agit de pointeurs JSON valides dans le fichier.
Remarque: Si le fichier OpenAPI qui définit votre API utilise une zone $ref pour référencer un fragment de code OpenAPI défini dans un fichier distinct, la zone $ref est remplacée par le contenu du fichier cible avant que le produit qui contient l'API ne soit mis en préproduction ou publié (la zone $ref n'est prise en charge que si vous utilisez API Connect toolkit de développement). Pour plus d'informations, voir Utilisation de $ref pour réutiliser des fragments de code dans vos fichiers OpenAPI.

Procédure

Pour mettre un produit en préproduction, procédez comme suit :
  1. Facultatif: Si vous avez des comptes sur plusieurs organisations de type fournisseur, vous pouvez sélectionner une nouvelle organisation de type fournisseur pour la mise en préproduction et la publication dans le menu Organisation .
  2. Dans le volet de navigation, cliquez Icône de développement dans le panneau de navigation sur « Développement ».
  3. Sélectionnez l'onglet Produits .
  4. Vous pouvez mettre en préproduction un produit à partir de la page de liste Développement ou à partir du produit lui-même.
    1. Pour mettre en production un produit depuis la page de liste « Développement », cliquez sur l'icône du menu des options Icône Options à côté de la version du produit souhaitée, puis sélectionnez « Mettre en production ».
    2. Pour mettre en préproduction un produit à partir du produit lui-même, procédez comme suit :
      1. Cliquez sur la version de produit que vous souhaitez utiliser.
      2. Cliquez sur l'icône du menu des options :
        Capture d'écran mettant en évidence l'icône du menu d'options
      3. Sélectionnez Etape.
  5. Sélectionnez le catalogue dans lequel vous souhaitez mettre en préproduction le produit.
  6. Si des espaces ont été activés dans le catalogue sélectionné, sélectionnez l' espace dont vous avez besoin.
    Remarque: Les catalogues que vous pouvez sélectionner sont ceux qui sont définis pour le serveur de gestion et l'organisation de type fournisseur auxquels vous êtes connecté.

    Si vous utilisez l'interface utilisateur du gestionnaire d'API, les détails de la connexion sont déterminés par l' URL gestionnaire d'API que vous ouvrez et par l'ID utilisateur avec lequel vous vous connectez. Si vous utilisez l'interface utilisateur d'API Designer, vous devez saisir les informations relatives au serveur de gestion et votre identifiant utilisateur dans la fenêtre de connexion qui s'ouvre lors du premier lancement d'API Designer; voir Connexion à API Designer.

    Pour plus d'informations sur la création d'un catalogue dans une organisation de type fournisseur, voir Création et configuration de catalogues.

  7. Si, lorsque le produit mis en préproduction est publié par la suite, vous souhaitez qu'il soit publié uniquement sur des services de passerelle sélectionnés, sélectionnez Publier dans des services de passerelle spécifiques, puis sélectionnez les services de passerelle requis. Seuls les services de passerelle dont le type correspond au paramètre de type de passerelle pour le produit sont répertoriés. Pour plus d'informations sur les types de passerelles, consultez la API Connect section « Types de passerelles ».
  8. Cliquez sur Suivant.

Résultats

Votre produit est mis en préproduction dans un catalogue. Vous pouvez afficher l'état du produit dans le catalogue dans API Manager. Si vous avez mis en préproduction le produit à partir d' API Designer, vérifiez que vous êtes connecté à API Manager avec le même nom d'utilisateur et le même mot de passe que ceux que vous avez utilisés pour API Designer. Cliquez sur Icône Gérer dans le panneau de navigation de l'interface utilisateur d'API Manager Manage dans l'interface utilisateur du gestionnaire d'API, puis sélectionnez le catalogue requis. Le produit est affichée avec l'état Préproduction.

Pour plus d'informations sur le cycle de vie d'un produit, voir Cycle de vie du produit.

Si une approbation est requise pour mettre en préproduction des produits dans le catalogue, une demande d'approbation est envoyée et le produit passe à l'état En attente. Il est mis en préproduction dès l'approbation de la demande. Si aucune approbation n'est requise, le produit est immédiatement mis en préproduction.

Pour plus d'informations sur la configuration des validations du cycle de vie des produits pour un catalogue, consultez la section Création et configuration des catalogues. Pour plus d'informations sur l'approbation des demandes, consultez la section « Approuver les demandes relatives au cycle de vie des produits et aux abonnements ».

Si le produit ne contient aucun plan, un plan appelé plan par défaut est ajouté automatiquement au produit dans le catalogue.

Etape suivante

  • Publiez votre produit afin que les développeurs d'applications puissent y accéder dans le catalogue grand public. Pour plus d'informations, consultez la section « Publication d'un produit ».