Déclarer des dépendances

Cette page s'applique à Apigee et à Apigee hybrid.

Preview — Apigee API hub

Cette fonctionnalité est soumise aux "Conditions des offres de pré-DG" dans la section "Conditions d'utilisation générales" des Conditions spécifiques au service. Les fonctionnalités pré-DG sont disponibles "en l'état" et peuvent avoir une assistance limitée. Pour en savoir plus, consultez les descriptions des étapes de lancement.

Autorisations requises : vous devez disposer des autorisations d'administrateur pour afficher la page Paramètres et déclarer des dépendances.

Les volets ci-dessous s'affichent en bas de la page Présentation de l'API et utilisent des liens pour indiquer différentes informations concernant l'API :

• Éléments associés : informations diverses liées à l'API
• Dépendances : toutes les dépendances de l'API pouvant s'avérer pertinentes, y compris les API internes, les API tierces externes et les autres systèmes de production

Vous pouvez définir plusieurs sections ou types de liens associés. Ces types s'appuient sur une taxonomie du système pouvant être modifiée pour plus de flexibilité dans la structure organisationnelle. Un élément de taxonomie spécial est défini par le système et vous permet de ne spécifier que les dépendances internes de l'API ; le système va ainsi déduire les relations de dépendance de l'API dans l'ensemble du hub d'API.

Associés

Le volet Éléments associés affiche des liens vers diverses informations liées à l'API. Par exemple, un dépôt de code source, une documentation de conception ou des systèmes d'infrastructure.

Toutes les informations du volet Éléments associés sont définies manuellement. Vous pouvez ajouter, modifier, supprimer et ordonnerles informations sur les éléments associés.

Ajouter des éléments associés

Pour ajouter des éléments au volet Éléments associés, procédez comme suit :

1. Dans la console Google Cloud, accédez à la page API Hub.

   Accéder à l'API Hub

   La page de la liste des API s'affiche par défaut.

2. Dans la liste API, cliquez sur une ligne d'API. L'onglet Présentation s'affiche par défaut.
3. Dans le volet Éléments associés, cliquez sur Modifier.
4. Renseignez les champs suivants :
   • Code source :
     1. Cliquez sur Ajouter un code source.
     2. Veuillez indiquer un nom.
     3. Spécifiez une URL.

   • Exemples d'API d'organisation :

     Remarque : Le nom de l'organisation affiché ici est le nom de l'organisation que vous définissez dans la section Personnaliser l'affichage. Dans le cas présent, le nom de l'organisation est "Exemple d'organisation".
     1. Cliquez sur Ajouter un exemple d'API d'organisation.
     2. Sélectionnez une API dans la liste.
   • Autre :
     1. Cliquez sur Ajouter "Autre".
     2. Spécifiez un nom d'API.
     3. Spécifiez une URL à utiliser pour les appels d'API.
5. Cliquez sur Enregistrer (ou Annuler).

Modifier des éléments associés

Pour modifier des éléments dans le volet Éléments associés, procédez comme suit :

1. Dans la console Cloud, accédez à la page API Hub.

   Accéder à l'API Hub

   La page de la liste des API s'affiche par défaut.

2. Dans la liste API, cliquez sur une ligne d'API. L'onglet Présentation s'affiche par défaut.
3. Dans le volet Éléments associés, cliquez sur Modifier.
4. Apportez les modifications nécessaires.
5. Cliquez sur Enregistrer (ou Annuler).

Supprimer des éléments associés

Pour supprimer des éléments du volet Éléments associés :

1. Dans la console Cloud, accédez à la page API Hub.

   Accéder à l'API Hub

   La page de la liste des API s'affiche par défaut.

2. Dans la liste API, cliquez sur une ligne d'API. L'onglet Présentation s'affiche par défaut.
3. Dans le volet Éléments associés, cliquez sur Modifier.
4. Cliquez sur Supprimer à côté de l'élément souhaité.
5. Cliquez sur Supprimer (ou Annuler) dans la boîte de dialogue de confirmation.
6. Cliquez sur Enregistrer (ou Annuler).

Ordonner des éléments associés

Pour ordonner des éléments dans le volet Éléments associés, procédez comme suit :

1. Dans la console Cloud, accédez à la page API Hub.

   Accéder à l'API Hub

   La page de la liste des API s'affiche par défaut.

2. Dans la liste API, cliquez sur une ligne d'API. L'onglet Présentation s'affiche par défaut.
3. Dans le volet Éléments associés, cliquez sur Modifier.
4. Cliquez sur Déplacer vers le bas ou Déplacer vers le haut à côté de l'élément souhaité.
5. Cliquez sur Enregistrer (ou Annuler).

Dépendances

Le volet Dépendances présente la liste de toutes les dépendances de l'API, y compris les autres API internes (présentes dans le hub d'API), les API tierces externes (non présentes dans le hub d'API) et les autres systèmes de production (par exemple, les bases de données et solutions de stockage).

Toutes les informations du volet Dépendances sont définies manuellement. Vous pouvez ajouter, modifier, supprimer et ordonner des dépendances.

Ajouter une dépendance

Pour ajouter des éléments au volet Dépendances, procédez comme suit :

1. Dans la console Cloud, accédez à la page API Hub.

   Accéder à l'API Hub

   La page de la liste des API s'affiche par défaut.

2. Dans la liste API, cliquez sur une ligne d'API. L'onglet Présentation s'affiche par défaut.
3. Dans le volet Dépendances, cliquez sur Modifier.
4. Renseignez les champs suivants :

   • Exemples d'API d'organisation :

     Remarque : Le nom de l'organisation affiché ici est le nom de l'organisation que vous définissez dans la section Personnaliser l'affichage. Dans le cas présent, le nom de l'organisation est "Exemple d'organisation".
     1. Cliquez sur Ajouter un exemple d'API d'organisation.
     2. Sélectionnez une API dans la liste.
   • API tierces :
     1. Cliquez sur Ajouter des API tierces.
     2. Spécifiez un nom d'API.
     3. Spécifiez une URL à utiliser pour les appels d'API.
   • Autre :
     1. Cliquez sur Ajouter "Autre".
     2. Spécifiez un nom d'API.
     3. Spécifiez une URL à utiliser pour les appels d'API.
5. Cliquez sur Enregistrer (ou Annuler).

Modifier une dépendance

Pour modifier le volet Dépendances, procédez comme suit :

1. Dans la console Cloud, accédez à la page API Hub.

   Accéder à l'API Hub

   La page de la liste des API s'affiche par défaut.

2. Dans la liste API, cliquez sur une ligne d'API. L'onglet Présentation s'affiche par défaut.
3. Dans le volet Dépendances, cliquez sur Modifier.
4. Apportez les modifications nécessaires.
5. Cliquez sur Enregistrer (ou Annuler).

Supprimer une dépendance

Pour supprimer un élément du volet Dépendances, procédez comme suit :

1. Dans la console Cloud, accédez à la page API Hub.

   Accéder à l'API Hub

   La page de la liste des API s'affiche par défaut.

2. Dans la liste API, cliquez sur une ligne d'API. L'onglet Présentation s'affiche par défaut.
3. Dans le volet Dépendances, cliquez sur Modifier.
4. Cliquez sur Supprimer à côté de l'élément souhaité.
5. Cliquez sur Supprimer (ou Annuler) dans la boîte de dialogue de confirmation.
6. Cliquez sur Enregistrer (ou Annuler).

Ordonner des dépendances

Pour ordonner les éléments dans le volet Dépendances, procédez comme suit :

1. Dans la console Cloud, accédez à la page API Hub.

   Accéder à l'API Hub

   La page de la liste des API s'affiche par défaut.

2. Dans la liste API, cliquez sur une ligne d'API. L'onglet Présentation s'affiche par défaut.
3. Dans le volet Dépendances, cliquez sur Modifier.
4. Cliquez sur Déplacer vers le bas ou Déplacer vers le haut à côté de l'élément souhaité.
5. Cliquez sur Enregistrer (ou Annuler).