Gestire un'API dal nome di dominio

OpenAPI | gRPC

Questa pagina mostra come pubblicare un'API da un dominio personalizzato di tua proprietà, ad esempio example.com.

In alternativa all'utilizzo del tuo nome di dominio, puoi usare un nome di dominio gestito da Google. Per ulteriori informazioni, consulta Utilizzo di un dominio gestito da Google.

Prima di iniziare

Ottieni un nome di dominio da un registrar di nomi di dominio, se non hai già un nome di dominio da utilizzare per la tua API.
Verificare la proprietà del dominio.
Assegna un nome all'host dell'API con il tuo nome di dominio.
Se utilizzi il protocollo SSL con il tuo dominio, ottieni e carica il tuo certificato SSL.
Esegui il deployment dell'API e di Extensible Service Proxy (ESP).

Configura il progetto API per utilizzare il tuo nome di dominio

Segui le istruzioni nella scheda appropriata.

App Engine

Per impostare il progetto API in modo che utilizzi il dominio verificato, segui le istruzioni fornite in Aggiungere un dominio personalizzato per l'applicazione

Compute Engine

Il metodo consigliato per gestire un'API dalle istanze Compute Engine consiste nell'utilizzare un bilanciatore del carico in un gruppo di istanze. Devi prenotare un indirizzo IP esterno per il nome di dominio e utilizzarlo per il bilanciatore del carico.

Per pubblicare l'API da un nome di dominio:

Prenota almeno un indirizzo IP esterno statico nel tuo progetto:

Vai alla pagina Indirizzi IP esterni

Assegna il nome che preferisci all'indirizzo IP riservato
In Tipo, fai clic su Globale.
In Allegato a, fai clic su Nessuno. Potrai collegare l'indirizzo IP a un bilanciatore del carico in un secondo momento.

Visita l'account del tuo provider di dominio e modifica le impostazioni del dominio. Devi creare un record A contenente il nome dell'API, ad esempio myapi.example.com con l'indirizzo IP esterno nel relativo campo dati
Crea un gruppo di istanze che includa le istanze che eseguono l'API ed Extensible Service Proxy (ESP:
)
Vai alla pagina Crea un nuovo gruppo di istanze

Assegna il nome che preferisci al gruppo e aggiungi una descrizione.
Nell'elenco Zona, fai clic sulla zona utilizzata dall'istanza dell'API.
Nell'elenco Definizione di istanza, fai clic su Seleziona istanze esistenti.
Nel campo Istanze VM, aggiungi l'istanza VM che esegue l'API.
Fai clic su Crea.

Crea e configura un bilanciatore del carico HTTP(S):

Vai alla pagina Crea un nuovo bilanciatore del carico HTTP(S)

Fai clic su Definisci un servizio di backend > Crea o seleziona un servizio di backend.
Assegna il nome e la descrizione che preferisci per la configurazione di questo servizio di backend.
Nel campo Protocollo, seleziona il protocollo da supportare tramite il bilanciatore del carico, HTTP o HTTPS.
Nell'elenco Gruppo di istanze, fai clic sul gruppo di istanze.
Nel campo Numeri porta, inserisci 8080.
Fai clic su Controllo di integrità per configurare i controlli di integrità:

Inserisci un nome per la configurazione del controllo di integrità.
Assegna la porta 8080.
Per accettare i valori predefiniti rimanenti, fai clic su Salva.

Per ora, accetta i valori predefiniti per il resto della configurazione. Puoi apportare modifiche in un secondo momento, ad esempio altre porte.
Non è necessario impostare alcuna impostazione nelle regole host e percorso; puoi inoltrare tutto all'API di backend utilizzando i filtri predefiniti Qualsiasi senza corrispondenza. Ciò significa che tutto il traffico nel bilanciatore del carico viene indirizzato all'API sulla porta 8080 (la porta predefinita), come definito nei passaggi precedenti.
Fai clic su Configurazione frontend.

Nel campo Protocollo, seleziona il protocollo da supportare tramite il bilanciatore del carico, HTTP o HTTPS.
Nell'elenco IP, fai clic sull'indirizzo IP esterno creato in precedenza.
Per il protocollo HTTPS, devi utilizzare SSL. Nell'elenco Certificato, fai clic sul certificato che ti interessa.
Facoltativamente, se vuoi supportare un altro protocollo, fai clic su Aggiungi IP e porta frontend, specifica il protocollo, lo stesso indirizzo IP esterno e una porta diversa.

Per creare il bilanciatore del carico completamente configurato, fai clic su Crea. Se il pulsante Crea non è abilitato, controlla i componenti appena configurati: accanto a ogni componente di configurazione dovrebbe apparire un segno di spunta. Se il segno di spunta manca, significa che non hai completato la configurazione.
Dopo la propagazione delle modifiche DNS, le richieste vengono inviate alla tua API utilizzando il bilanciatore del carico.

Nota: se le richieste non arrivano al backend dell'API, controlla le regole firewall del tuo progetto per assicurarti che le tue istanze possano accettare il traffico sulla porta ESP predefinita 8080. Per maggiori informazioni, consulta la sezione Firewall.

GKE

Per gestire un'API su un dominio per Google Kubernetes Engine (GKE), devi esporre ESP come servizio utilizzando l'indirizzo IP esterno restituito per le impostazioni DNS del dominio. Tieni presente che GKE esegue automaticamente il bilanciamento del carico al posto tuo.

Per esporre l'API come servizio:

Se non ne hai già uno, configura un servizio Kubernetes per i backend API. Crea un file di configurazione del servizio, service.yaml, con contenuti simili ai seguenti:

            apiVersion: v1
            kind: Service
            metadata:
              name: echo
            spec:
              ports:
              - port: 80
                targetPort: 8081
                protocol: TCP
              selector:
                app: echo-app
              type: LoadBalancer

Modifica l'etichetta selector in modo che corrisponda alle etichette di backend (app: echo-app in questo esempio)
Assicurati che targetPort corrisponda alla porta utilizzata da ESP configurata nei backend API. ESP utilizza la porta 8081 per impostazione predefinita.

Esegui il deployment del servizio Kubernetes:

            kubectl apply -f service.yaml

Visualizza l'indirizzo IP esterno assegnato al servizio esposto:
```
            kubectl get services
            
```
L'output mostra un indirizzo EXTERNAL-IP simile al seguente:
```
            NAME         CLUSTER-IP     EXTERNAL-IP      PORT(S)    AGE
            hello-node   10.X.XXX.202   10X.XXX.XX.123   8080/TCP   1m
      
```
Nota: l'esposizione dell'API come servizio richiede un po' di tempo e l'IP esterno non sarà visibile fino al completamento del processo. Di conseguenza, potrebbe essere necessario eseguire kubectl get services più volte prima di vedere l'indirizzo IP.
Modifica l'IP esterno generato da temporaneo a statico.

Vai alla pagina Indirizzi IP esterni

Seleziona il tuo indirizzo IP esterno dall'elenco.
Nell'elenco Tipo, fai clic su Statico.

Visita l'account del tuo provider di dominio e modifica le impostazioni del dominio. Devi creare un record A contenente il nome dell'API, ad esempio myapi.example.com, con l'indirizzo IP esterno nel campo dei dati.

Passaggi successivi

Gestione di più API da un dominio