Introduzione alle dipendenze

Questa pagina si applica ad Apigee e Apigee hybrid.

Anteprima - Apigee API hub

Questa funzionalità è soggetta ai "Termini delle Offerte pre-GA" nella sezione Termini generali del servizio dei Termini specifici dei servizi. Le funzionalità pre-GA sono disponibili "così come sono" e potrebbero avere un supporto limitato. Per saperne di più, consulta le descrizioni della fase di lancio.

Le dipendenze dell'hub API consentono di visualizzare e gestire le relazioni tra le operazioni dell'API. L'individuazione e il monitoraggio delle dipendenze di un'API consentono di gestire l'ecosistema delle API in modo più efficiente. Ad esempio, le dipendenze possono aiutarti a scoprire il potenziale impatto della modifica o del ritiro di un'API, a risolvere i problemi o ad analizzare la conformità alle normative sui costi o di conformità. Le API possono essere archiviate 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'altra il consumatore. Ad esempio, supponiamo che l'API PetStore chiami un'operazione nell'API Location. In questo caso, l'API PetStore dipende da un'operazione fornita dall'API Location. Nell'hub API, facciamo riferimento a PetStore come consumatore e Località come fornitore.

Nota: per la versione di anteprima, l'hub API supporta dipendenze basate su operazioni API o API esterne (API non archiviate nell'hub API). Puoi scegliere il tipo di dipendenza quando la crei.

La Figura 1 illustra il rapporto tra fornitore e consumatore tra le operazioni dell'API. L'operazione /debit dell'API Payment 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 operazioni fornite dall'API UserProfile e dall'API GeoLocation. In questo caso, l'operazione /detect è il consumatore e le altre due sono i fornitori.

Figura 1. Mappatura delle dipendenze API

Crea una dipendenza

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

1. Trova due API che potrebbero avere dipendenze che vuoi monitorare.
2. Elenca le versioni delle due API utilizzando l'API List Versions. In alternativa, puoi utilizzare l'API List Operations e filtrare i risultati per trovare le operazioni dipendenti.
3. Determina quale operazione è il fornitore e quale il consumatore. Come discusso in precedenza, l'operazione consumer richiama un'operazione da parte del fornitore.
4. Utilizza l'API Create Dependency per creare la dipendenza tra l'operazione del fornitore e quella del 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 dipendenze nell'hub API. L'API consente di filtrare in base ad attributi chiave, tra cui il nome dell'operazione di origine, il nome dell'operazione di destinazione e lo stato della dipendenza.

I passaggi di base per trovare le dipendenze sono:

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

Ecco una chiamata API di esempio 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 interrotte, segui questi passaggi di base:

1. Utilizza l'API List Dependency per elencare tutte le dipendenze o 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 per visualizzare in dettaglio eventuali dipendenze interrotte e scoprire ulteriori dettagli come il nome del fornitore.

   Di seguito è riportato 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 di una dipendenza, trovarle filtrando un elenco di tutte le dipendenze nell'hub API, eliminare una dipendenza e aggiornarne la descrizione. Tutte le API Dependency sono descritte in dettaglio nel riferimento API e in Gestire le dipendenze.