Introduzione alle dipendenze

Questa pagina si applica a Apigee e Apigee ibridi.

Le dipendenze dell'hub API consentono di visualizzare e gestire le relazioni tra le operazioni API. Individuazione e monitoraggio delle dipendenze di un'API consente di gestire l'ecosistema API in modo più efficiente. Ad esempio, le dipendenze possono aiutare scoprirai il potenziale impatto della modifica o del ritiro di un'API, risolvi i problemi o analizzare il rispetto delle normative di costi o conformità. Le API possono essere archiviati all'interno dell'hub API o all'esterno dell'hub API.

Che cos'è una dipendenza?

L'hub API modella una dipendenza come relazione direzionale tra le operazioni API, in cui un'operazione API è il fornitore e l'altro il consumatore. Supponiamo, ad esempio, che le chiamate API PetStore un'operazione nell'API Location. In questo caso, l'API PetStore dipende da una fornita dall'API Location. Nell'hub API, ci riferiamo a PetStore come consumatore e Location come fornitore.

La Figura 1 illustra la relazione fornitore/consumatore tra le operazioni API. L'operazione /debit dell'API Fraud utilizza l'operazione /detect dell'API Fraud Detection. L'operazione di addebito il consumatore e l'operazione di rilevamento di attività fraudolenta è il fornitore in questa relazione.

Allo stesso modo, /detect utilizza le operazioni fornite dall'API UserProfile e l'API GeoLocation. In questo caso, l'operazione /detect è il consumer e le altre due sono i fornitori.

Dipendenze dell'hub API Dipendenze dell'hub API

Figura 1. Mappatura delle dipendenze API

Crea una dipendenza

Puoi creare una dipendenza tra le operazioni API aggiunte all'hub API da una specifica API caricata oppure un'API esterna.

I passaggi di base per creare una dipendenza nell'hub API sono:

  1. Trova due API che potrebbero avere operazioni che potrebbero dipendere. Le operazioni possono essere in API registrate o API esterne.
  2. Determina quale API è il fornitore e quale il consumatore. Come detto in precedenza, il consumatore richiama il fornitore.
  3. Utilizza l'API Create Dependency per creare la dipendenza tra il fornitore e il consumatore.

Per maggiori dettagli sulla chiamata all'API Create Dependency e un esempio, consulta Crea l'API Dependency.

Trova le dipendenze

L'API List Dependency è un buon modo per trovare le dipendenze nell'hub API. L'API consente filtri in base ai campi consumer.operation_resource_name, consumer.external_api_resource_name, supplier.operation_resource_name e supplier.external_api_resource_name.

I passaggi di base per individuare le dipendenze sono:

  1. Utilizza l'API List Dependency per elencare tutte le dipendenze o utilizzare la funzionalità di filtro dell'API per restringere la ricerca.
  2. Utilizza l'API Get Dependency ed esaminare in dettaglio le eventuali dipendenze interrotte per scoprire maggiori dettagli come il nome del fornitore.

Ecco un esempio di chiamata API per elencare le dipendenze: 

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"

Identifica le dipendenze interrotte

Per identificare le dipendenze non funzionanti, segui questi passaggi di base:

  1. Utilizza l'API List Dependency per elencare tutte le dipendenze o utilizzare la funzionalità di filtro dell'API per restringere la ricerca.
  2. Identifica quali delle dipendenze restituite hanno un flag di errore impostato.
  3. Utilizza l'API Get Dependency ed esaminare in dettaglio le eventuali dipendenze interrotte per scoprire maggiori dettagli come il nome del fornitore.

    Ecco un esempio di risposta, in cui la condizione di errore indica che l'operazione del fornitore è stata rimossa:

    {
  "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
  }
}

Altre operazioni di dipendenza

Dopo aver creato una dipendenza, puoi utilizzare le API dell'hub API per ottenere i dettagli relativi a una dipendenza. filtrando un elenco di tutte le dipendenze nell'hub API, elimina una dipendenza e aggiorna la descrizione di una dipendenza. Tutte le API Dipendenza sono descritte in dettaglio in nel Riferimento API e in Gestire le dipendenze.