Gestisci deployment

Questa pagina si applica ad Apigee e Apigee hybrid.

Un'API può avere più deployment. Ad esempio: regioni o ambienti di gestione temporanea diversi. Un deployment è una località (un indirizzo) in cui gli utenti possono accedere a un'API. Uno di questi deployment può essere indicato come deployment consigliato.

La scheda Deployment mostra tutti i deployment per l'API configurati da un utente con autorizzazioni di modifica. I deployment sono elencati in ordine alfabetico per ambiente.

Scheda Deployment, fai clic per ingrandire l'immagine
Visualizza schema del registro delle API

Di seguito vengono illustrate le relazioni tra le API, le versioni, i deployment e le specifiche dell'API Hub.

alt_text
Riferimento Elemento Descrizione
Registro Un registro è una raccolta di API che funge da catalogo di API.
Versione Un'API può avere più versioni. Una versione deve corrispondere a un'interfaccia stabile che i client possono utilizzare per chiamare un'API. Una di queste versioni potrebbe essere designata come versione consigliata. Nella terminologia semver, una best practice prevede che le versioni siano versioni principali.
Deployment Un'API può avere più deployment, ad esempio regioni o ambienti di gestione temporanea diversi. Un deployment è una località (un indirizzo) in cui gli utenti possono accedere a un'API. Uno di questi deployment può essere quello consigliato.
Specifica È consigliabile, ma non obbligatorio, che una versione dell'API sia descritta da specifiche formali, spesso utilizzando diversi formati delle specifiche dell'API. Uno di questi formati di specifica può essere quello principale, il che indica che da questa sono derivate altre specifiche per questa versione.
Revisioni
  • I deployment hanno una cronologia delle revisioni. Le revisioni del deployment rappresentano particolari istanze di un deployment nel tempo e possono fare riferimento a una o più revisioni delle specifiche se l'implementazione dell'API gestita dal deployment è cambiata.
  • Le specifiche dispongono di una cronologia delle revisioni. Le revisioni delle specifiche rappresentano istanze successive di una specifica e in genere rappresentano modifiche non significative ai contenuti delle specifiche. Nella terminologia semver, le revisioni potrebbero corrispondere a versioni secondarie o a punti.

Aggiungi deployment

Per aggiungere un deployment:

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

    Vai all'hub API

    Per impostazione predefinita, viene visualizzata la pagina dell'elenco delle API.

  2. Nell'elenco API, fai clic su una riga dell'API. Per impostazione predefinita viene visualizzata la scheda Panoramica.
  3. Seleziona la scheda Deployment.
  4. Fai clic su Aggiungi deployment.
  5. Inserisci o seleziona quanto segue:
    • 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 creazione di un deployment.
    • Ambiente: la località in cui è disponibile un'istanza di un'API. Ad esempio: Produzione, Gestione temporanea, Test ecc.
    • Gateway:il tipo di gateway. Il proxy utilizzato per gestire e proteggere l'API. Definita come tassonomia di sistema.
    • Versione API: la versione dell'API fornita da questo deployment. Se una versione non ha revisioni, viene contrassegnata come tale nell'elenco e non può essere selezionata.

      Versione, nessuna revisione
    • Nome e URL del canale esterno. Un'etichetta e l'URL di un link a un canale esterno per l'API, ad esempio un Portale per gli sviluppatori.
    • Accedere alle informazioni
      • Indicazioni per l'utilizzo:indicazioni che specificano il pubblico per l'implementazione. Ad esempio, consumo pubblico, test interni e così via.
      • Endpoint del server: l'endpoint del server per l'API
      • Indicazioni per l'accesso: contenuti di markdown in formato libero che descrivono come i consumer delle API possono accedere al deployment
  6. Fai clic su Salva (o Annulla).

Modifica deployment

Per modificare un deployment:

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

    Vai all'hub API

    Per impostazione predefinita, viene visualizzata la pagina dell'elenco delle API.

  2. Nell'elenco API, fai clic su una riga dell'API. Per impostazione predefinita viene visualizzata la scheda Panoramica.
  3. Seleziona la scheda Deployment.
  4. Fai clic su Altro > Modifica accanto al deployment che ti interessa.
  5. Apporta le modifiche necessarie.
  6. Aggiorna revisione: questa casella di controllo viene visualizzata quando la versione attualmente selezionata ha una revisione delle specifiche più recente di quella già assegnata al deployment. Seleziona questa casella per aggiornare la revisione delle specifiche di cui è stato eseguito il deployment.

    Casella della revisione dell'aggiornamento del deployment
  7. Fai clic su Salva (o Annulla).

Elimina deployment

Per eliminare un deployment:

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

    Vai all'hub API

    Per impostazione predefinita, viene visualizzata la pagina dell'elenco delle API.

  2. Nell'elenco API, fai clic su una riga dell'API. Per impostazione predefinita viene visualizzata la scheda Panoramica.
  3. Seleziona la scheda Deployment.
  4. Fai clic su Altro > Elimina accanto al deployment desiderato.
  5. Fai clic su Elimina (o Annulla) nella finestra di richiesta.

Per impostare o cancellare un deployment consigliato:

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

    Vai all'hub API

    Per impostazione predefinita, viene visualizzata la pagina dell'elenco delle API.

  2. Nell'elenco API, fai clic su una riga dell'API. Per impostazione predefinita viene visualizzata la scheda Panoramica.
  3. Seleziona la scheda Deployment.
  4. Nella riga di deployment che ti interessa, fai clic su Altro > Imposta come consigliato. Non puoi cancellare un deployment consigliato; puoi solo specificare un deployment diverso come quello consigliato.

Chiedi l'accesso

Per visualizzare le informazioni su come accedere a un'API:

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

    Vai all'hub API

    Per impostazione predefinita, viene visualizzata la pagina dell'elenco delle API.

  2. Nell'elenco API, fai clic su una riga dell'API. Per impostazione predefinita viene visualizzata la scheda Panoramica.
  3. Dal riquadro Generale o dalla scheda Deployment, fai clic su Ottieni accesso per aprire il riquadro Accesso dell'API. Se non è presente il pulsante Ottieni accesso, significa che non è stata fornita alcuna informazione. Consulta Aggiungere deployment per istruzioni sull'aggiunta di informazioni sull'accesso.
  4. Seleziona un Deployment dall'elenco. Se un deployment non ha informazioni sull'accesso, viene contrassegnato come tale nell'elenco e non può essere selezionato.

    Deployment senza informazioni sull'accesso

Vai al canale esterno

Per accedere a un canale esterno:

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

    Vai all'hub API

    Per impostazione predefinita, viene visualizzata la pagina dell'elenco delle API.

  2. Nell'elenco API, fai clic su una riga dell'API. Per impostazione predefinita viene visualizzata la scheda Panoramica.
  3. Seleziona la scheda Deployment.
  4. Fai clic su un link Canale esterno per passare a un canale esterno, ad esempio un portale, se ne è stato definito.