Spécification du type de passerelle pour une définition d'API

Modifier en ligne

Une définition d'API est spécifique à l'un ou l'autre des types de passerelle, DataPower® API Gateway ou DataPower Gateway (v5 compatible). Un type de passerelle par défaut est défini lors de la création d'une définition d'API, mais vous pouvez éditer la configuration d'API afin de spécifier un autre type de passerelle.

A propos de cette tâche

Remarque: Cette tâche concerne uniquement une définition d'API OpenAPI 2.0 . Une API OpenAPI 3.0 est prise en charge uniquement sur le DataPower API Gateway.

DataPower Gateway (v5 compatible) est disponible avec IBM® API Connect depuis un certain nombre d'années. DataPower API Gateway est une nouvelle passerelle qui a été conçue avec les API à l'esprit et avec le même objectif de sécurité que DataPower Gateway (v5 compatible).

Pour plus d'informations sur le choix du type de passerelle à utiliser, voir Types de passerelleAPI Connect.

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.

Vous devez spécifier le type de passerelle que chaque API utilise. Les API ne peuvent utiliser qu'un seul type de passerelle.

Lorsque vous créez une définition d'API, ou que vous importez une définition d'API qui ne comporte pas de type de passerelle configuré, le type de passerelle proposé par défaut dépendra des types de passerelle des services passerelles qui sont activés dans votre catalogue pour bac à sable, comme illustré dans le tableau ci-dessous.

Tableau 1. Type de passerelle par défaut pour une nouvelle définition d'API
Activation du service passerelle dans le catalogue pour bac à sable Type de passerelle par défaut pour une nouvelle définition d'API
Aucun service passerelle activé DataPower API Gateway
Au moins un service passerelle de chaque type activé DataPower API Gateway
Un ou plusieurs services de passerelle de type DataPower API Gateway uniquement activés DataPower API Gateway
Un ou plusieurs services de passerelle de type DataPower Gateway (v5 compatible) uniquement activés DataPower Gateway (v5 compatible)
Si vous importez une définition d'API qui comporte déjà un type de passerelle configuré, ce type est utilisé.

Notez que, lorsque vous modifiez vos définitions d'API pour utiliser un type de passerelle spécifique, vous devez vous assurer que chaque stratégie et version de stratégie dans l'API est prise en charge par le type de passerelle. DataPower Gateway (v5 compatible) et DataPower API Gateway prennent chacune en charge des stratégies que l'autre type de passerelle ne prend pas en charge. Dans certains cas de figure, une même stratégie sera prise en charge par les deux types de passerelle, mais avec un numéro de version différent.

Par exemple, DataPower Gateway (v5 compatible) prend en charge la version 1.0.0 de la règle invoke , mais DataPower API Gateway requiert la version 2.0.0.

Pour plus d'informations sur les règles, voir execute.

Pour des informations sur les versions de stratégie, reportez-vous à la documentation relative à chaque stratégie individuelle. Par exemple, pour consulter la invoke politique, voir invoke.

À tout moment, vous pouvez accéder directement au fichier YAML source d' OpenAPI en cliquant sur l'icône Source OpenAPI Icône Source. Pour revenir au formulaire de conception, cliquez sur l'icône Formulaire Icône de formulaire.

Procédure

  1. Ouvrez l'API pour édition, comme décrit dans Edition d'une définition d'API OpenAPI 2.0.
  2. Cliquez sur le titre de l'API à mettre à jour.
  3. Sélectionnez l'onglet Passerelle , puis cliquez sur Paramètres de passerelle et de portail.
  4. Sélectionnez le type:
    • datapower-gateway pour DataPower Gateway (v5 compatible)
    • datapower-api-gateway pour DataPower API Gateway.
    Remarque: La sélection Type de passerelle n'est pas applicable si l'option Appliqué est désactivée, car une API non appliquée n'est pas gérée sur une passerelle API Connect .
  5. Cliquez sur Sauvegarder pour conserver les modifications.
  6. Dans le panneau de navigation, sélectionnez Stratégies pour vous assurer que votre API utilise des stratégies qui sont prises en charge par le type de passerelle que vous avez sélectionné.

    Les politiques d'une API existante qui ne sont pas prises en charge par le nouveau type de passerelle apparaissent en gris et sont signalées par un point d'exclamation rouge : point d'exclamation rouge pour une règle non prise en charge.

    Certaines stratégies sont prises en charge par un seul type de passerelle. D'autres le sont par les deux types, mais requièrent une version différente selon le type de passerelle.