Présentation des dépendances

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

Les dépendances du hub d'API vous aident à voir et à gérer les relations entre les opérations d'API. La recherche et le suivi des dépendances d'une API vous aident à gérer votre écosystème d'API plus efficacement. Par exemple, les dépendances peuvent vous aider à découvrir l'impact potentiel de la modification ou de l'abandon d'une API, à résoudre des problèmes ou à analyser le respect des réglementations en termes de coûts ou de conformité. Les API peuvent être stockées dans le hub d'API ou externes au hub d'API.

Qu'est-ce qu'une dépendance ?

Le hub d'API modélise une dépendance en tant que relation directionnelle entre des opérations d'API, une opération d'API représentant le fournisseur et l'autre le consommateur. Par exemple, supposons que l'API PetStore appelle une opération dans l'API de localisation. Dans ce cas, l'API PetStore dépend d'une opération fournie par l'API Location. Dans le hub d'API, nous appelons PetStore en tant que consommateur et emplacement en tant que fournisseur.

La figure 1 illustre la relation fournisseur/consommateur entre les opérations d'API. L'opération /debit de l'API Payment utilise l'opération /detect de l'API Fraud Detection. L'opération de débit est le consommateur, et l'opération de détection de fraude est le fournisseur dans cette relation.

De même, /detect utilise les opérations fournies par l'API UserProfile et l'API GeoLocation. Dans ce cas, l'opération /detect correspond au consommateur et les deux autres sont les fournisseurs.

Dépendances du hub d'API Dépendances du hub d'API

Figure 1. Mappage des dépendances d'API

Créer une dépendance

Les étapes de base pour créer une dépendance dans le hub d'API sont les suivantes:

  1. Recherchez deux API qui pourraient avoir des dépendances que vous souhaitez suivre.
  2. Répertoriez les versions des deux API à l'aide de l'API List Versions. Vous pouvez également utiliser l'API List Operations et filtrer les résultats pour rechercher les opérations dépendantes.
  3. Déterminez l'opération correspondant au fournisseur et au consommateur. Comme indiqué précédemment, l'opération client appelle une opération de la part du fournisseur.
  4. Utilisez l'API Create Dependency pour créer la dépendance entre l'opération du fournisseur et l'opération du client.

Pour en savoir plus sur l'appel de l'API Create Dependency et obtenir un exemple, consultez la page API Create Dependency.

Rechercher les dépendances

L'API List Dependency est un bon moyen de rechercher des dépendances dans le hub d'API. L'API vous permet d'effectuer un filtrage en fonction d'attributs clés, y compris le nom de l'opération source, le nom de l'opération de destination et l'état de la dépendance.

Les étapes de base pour rechercher des dépendances sont les suivantes:

  1. Utilisez l'API List Dependency pour répertorier toutes les dépendances ou utilisez la fonctionnalité de filtre de l'API pour affiner votre recherche.
  2. Utilisez l'API Get Dependency pour afficher le détail des dépendances interrompues et découvrir plus de détails, tels que le nom du fournisseur.

Voici un exemple d'appel d'API permettant de répertorier les dépendances : 

curl "https://apihub.googleapis.com/v1/projects/myproject/locations/us-central1/dependencies"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

Identifier les dépendances défectueuses

Pour identifier les dépendances non fonctionnelles, procédez comme suit:

  1. Utilisez l'API List Dependency pour répertorier toutes les dépendances ou utilisez la fonctionnalité de filtre de l'API pour affiner votre recherche.
  2. Identifiez les dépendances renvoyées pour lesquelles une option d'erreur est définie.
  3. Utilisez l'API Get Dependency pour afficher le détail des dépendances interrompues et découvrir plus de détails, tels que le nom du fournisseur.

    Voici un exemple de réponse, où la condition d'erreur indique que l'opération du fournisseur a été supprimée:

    {
  "name": "projects/common-dev-15/locations/us-central1/dependencies/user-to-pet",
  "consumer": {
      "displayName": "POST - /v2/user",
      "operationResourceName": "projects/common-dev-15/locations/us-central1/apis/payments-api/versions/2ff89c88-e8b6-48c4-a1c2-bdbb2a929bde/operations/createuser"
  },
  "supplier": {
      "displayName": "POST - /v2/pet",
      "operationResourceName": "projects/common-dev-15/locations/us-central1/apis/payments-api/versions/2ff89c88-e8b6-48c4-a1c2-bdbb2a929bde/operations/addpet"
  },
  "state": "VALIDATED",
  "description": "Dependency from user to pet API",
  "discoveryMode": "MANUAL",
  "createTime": "2024-04-17T19:33:31.215978712Z",
  "updateTime": "2024-04-17T19:33:31.737505297Z",
  {
    "error": "SUPPLIER_NOT_FOUND",
    "errorTime": 2024-05-18T20:23:42.465324Z
  }
}

Autres opérations de dépendance

Après avoir créé une dépendance, vous pouvez utiliser les API du hub d'API pour obtenir des détails sur une dépendance, trouver les dépendances en filtrant une liste de toutes les dépendances dans le hub d'API, supprimer une dépendance et mettre à jour sa description. Toutes les API de dépendances sont décrites en détail dans la documentation de référence de l'API et dans la section Gérer les dépendances.