Eseguire il deployment di un'API in un gateway

Questa pagina descrive come eseguire il deployment di un'API in API Gateway.

Prerequisiti

Prima di poter eseguire il deployment di un'API in API Gateway:

Requisiti per l'ID gateway

Molti dei comandi gcloud CLI descritti in questo documento richiedono di specificare l'ID del gateway, nel formato: GATEWAY_ID. API Gateway applica i seguenti requisiti per l'ID gateway:

  • La lunghezza massima è di 49 caratteri.
  • Deve contenere solo lettere minuscole, numeri o trattini.
  • Non deve iniziare con un trattino.
  • Non deve contenere un trattino basso.

Definire l'endpoint della configurazione API di cui è stato eseguito il deployment

Quando esegui il deployment di una configurazione API in un gateway, API Gateway crea un URL univoco per il gateway nel dominio gateway.dev. I client API utilizzano quindi un URL nel seguente formato per accedere alla configurazione API di cui è stato eseguito il deployment:

https://GATEWAY_ID-HASH.REGION_CODE.gateway.dev

dove GATEWAY_ID è il nome del gateway, HASH è il codice hash univoco generato durante il deployment dell'API, e REGION_CODE è il codice della località Cloud in cui hai eseguito il deployment del gateway.

Ad esempio:

https://my-gateway-a12bcd345e67f89g0h.uc.gateway.dev

Eseguire il deployment di un'API in un gateway

Per eseguire il deployment di un'API in un gateway:

Google Cloud Console

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

    Vai ad API Gateway

  2. Fai clic su Crea gateway.

    Viene visualizzata la pagina Crea gateway.

  3. In Seleziona un'API, seleziona Crea nuova API nel campo Seleziona un'API.
  4. Nel campo Nome visualizzato, inserisci il nome visualizzato dell'API.
  5. Nel campo ID API, inserisci l'ID dell'API. Consulta i requisiti per l'ID API per le linee guida per la denominazione delle API.
  6. (Facoltativo) Aggiungi etichette per l'API.
  7. Nella sezione Configurazione API, seleziona Crea una nuova configurazione API nel campo Seleziona una configurazione.
  8. Nel campo Carica una specifica API, carica un file .yaml o .json. Consulta Formati di file OpenAPI 2.0 e OpenAPI 3.x per la definizione dell'API.
  9. Nel campo Nome visualizzato, inserisci il nome visualizzato della configurazione API.
  10. Nell'elenco Seleziona un account di servizio, seleziona l'account di servizio richiesto. Questo account di servizio verrà utilizzato da API Gateway come identità.
  11. (Facoltativo) Aggiungi etichette per la configurazione API.
  12. Nella sezione Dettagli gateway, inserisci un nome visualizzato per il gateway.
  13. Nel campo Località, seleziona la Google Cloud regione in cui vuoi eseguire il deployment del gateway.
  14. (Facoltativo) Aggiungi etichette per API Gateway.
  15. Fai clic su Crea gateway.

    16. La nuova API creata è visibile nella home page di API Gateway.

Google Cloud CLI

  1. Convalida l'ID progetto restituito dal seguente comando per assicurarti che il gateway non venga creato nel progetto sbagliato.

    gcloud config list project

    Se devi modificare il progetto predefinito, esegui il seguente comando e sostituisci PROJECT_ID con l' Google Cloud ID progetto in cui vuoi creare il servizio:

    gcloud config set project PROJECT_ID

  2. Visualizza la guida per il comando gateway create:

    gcloud api-gateway gateways create --help

  3. Esegui il seguente comando per eseguire il deployment della configurazione API nel gateway:

    gcloud api-gateway gateways create GATEWAY_ID \
 --api=API_ID --api-config=CONFIG_ID \
 --location=GCP_REGION

    dove:

    • GATEWAY_ID specifica l'ID del nuovo gateway. Se il gateway non esiste già, questo comando lo crea.
    • API_ID specifica l'ID dell'API API Gateway associata a questo gateway.
    • CONFIG_ID specifica l'ID della configurazione API di cui è stato eseguito il deployment nel gateway. Devi specificare una configurazione API quando crei un gateway.
    • GCP_REGION specifica la località Cloud per il gateway di cui è stato eseguito il deployment.