Registrazione delle API

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.

La registrazione di un'API ne consente la rilevabilità da parte dei visualizzatori nell'elenco delle API.

Autorizzazioni richieste: devi disporre delle autorizzazioni di modifica o di amministratore per register, modificare o eliminare le registrazioni dell'API.

Registra un'API

Per registrare un'API:

1. Nella console Google Cloud, vai alla pagina Hub API.

   Vai all'hub API

   Per impostazione predefinita, viene visualizzata la pagina di elenco API.

2. Fai clic su Registra API. Viene visualizzato il riquadro API Register.
3. Specifica i seguenti dettagli dell'API:
   • ID:un identificatore di una risorsa API. L'ID può contenere solo lettere minuscole, numeri e trattini. L'ID deve essere univoco nel progetto. Gli ID devono avere una lunghezza compresa tra 4 e 63 caratteri. Gli ID non possono essere modificati dopo la registrazione di un'API. Ad esempio, per il nome della risorsa API: projects/my-project/locations/global/apis/my-api, l'ID risorsa è my-api.
   • Nome: inserisci il nome dell'API
   • Descrizione: inserisci la descrizione dell'API
   • Stile:
   • Stile: seleziona lo stile di architettura principale dell'API (ad esempio OpenAPI, GraphQL, AsyncAPI e così via, a seconda di come è stato configurato l'hub API).
   • Documento con descrizione dell'API: se disponi già di un documento descrittivo, fai clic su Sfoglia per caricarlo. Può essere un singolo file o un file ZIP (massimo 2 MB). Per informazioni sull'aggiunta e l'eliminazione delle revisioni, consulta la pagina Gestire le revisioni.
   • Tipo MIME: seleziona un tipo MIME. Il tipo MIME viene visualizzato dopo aver selezionato un documento descrittivo dell'API. Se selezioni Altro, viene visualizzato un campo di testo in cui puoi specificare manualmente il tipo MIME.
   • Versione attuale:
     • ID versione:il nome di una risorsa API. L'ID versione può contenere solo lettere minuscole, numeri e trattini. L'ID versione deve essere univoco nel progetto. Gli ID versione devono avere una lunghezza compresa tra 1 e 63 caratteri. Gli ID versione non possono essere modificati dopo la registrazione di un'API.
     • Versione: inserisci la versione iniziale
     • Fase del ciclo di vita dell'API: seleziona una fase del ciclo di vita dall'elenco.
   • Fine del ciclo di vita prevista:
     • Seleziona un'Aspettativa dall'elenco.
     • Se Aspettativa è Data minima, specifica una Data.
     • Se Aspettativa è Data confermata, specifica una Data.
   • Proprietà:
     • Tassonomie di sistema:

       • Utenti di destinazione:seleziona gli utenti di destinazione (consumer) per l'API.

       • Team: seleziona il team responsabile della produzione dell'API.
       • Unità aziendale: seleziona la business unit responsabile dell'API
     • Tassonomie personalizzate:
       Nota: potrebbero essere disponibili ulteriori proprietà personalizzate.
       • Seleziona eventuali altre tassonomie personalizzate elencate
   • Contatto principale:
     • Indirizzo email del contatto principale:l'indirizzo email del contatto principale per eventuali domande sull'API.
     • Descrizione del contatto principale:la descrizione del contatto principale.
4. Fai clic su Registra API (o Annulla).

Modifica dettagli registrazione API

Per modificare i dettagli di registrazione all'API:

1. Nella console Cloud, vai alla pagina Hub API.

   Vai all'hub API

   Per impostazione predefinita, viene visualizzata la pagina di elenco API.

2. Fai clic su un'API. Viene visualizzata la pagina Panoramica dell'API.
3. Fai clic su Modifica.
   Autorizzazioni richieste: se non vedi il link Modifica, significa che non disponi delle autorizzazioni di modifica.
4. Modifica i dettagli.
5. Fai clic su Salva (o Annulla).

Elimina API

Nota: ogni API deve avere una versione consigliata che non può essere eliminata.

L'eliminazione di un'API ne comporta la rimozione dal sistema. Se l'API potrebbe essere di interesse storico per altri utenti, anziché eliminarla, valuta la possibilità di utilizzare una fase del ciclo di vita Ritirata o Deprecata.

Per eliminare un'API:

1. Nella console Cloud, vai alla pagina Hub API.

   Vai all'hub API

   Per impostazione predefinita, viene visualizzata la pagina di elenco API.

2. Fai clic su un'API. Viene visualizzata la pagina Panoramica dell'API.
   
3. Fai clic su Elimina API.
   Autorizzazioni richieste: se non vedi il link Elimina API, significa che non disponi delle autorizzazioni di modifica.

4. Viene visualizzata una finestra di dialogo di conferma. Digita il nome dell'API e fai clic su Conferma (o Annulla).