Tutorial: creazione di un'API REST con integrazione privata API Gateway

Puoi creare un'API di API Gateway con integrazione privata per fornire ai clienti l'accesso alle risorse HTTP/HTTPS in Amazon Virtual Private Cloud (Amazon VPC). Tali risorse VPC sono endpoint HTTP/HTTPS su un'istanza EC2 regolati da un Network Load Balancer nel VPC. Network Load Balancer incapsula la risorsa VPC e instrada le richieste in ingresso alla risorsa di destinazione.

Quando un client chiama l'API, API Gateway si connette a Network Load Balancer mediante il collegamento VPC preconfigurato. Un collegamento VPC è incapsulato da una risorsa API Gateway di VpcLink. È responsabile dell'inoltro delle richieste del metodo API alle risorse VPC e restituisce le risposte di back-end all'intermediario. Per uno sviluppatore di API, VpcLink è funzionalmente equivalente a un endpoint di integrazione.

Per creare un'API con integrazione privata, devi crearne una nuova o scegliere un VpcLink esistente connesso a un Network Load Balancer che si rivolge alle risorse VPC desiderate. È necessario disporre delle autorizzazioni appropriate per creare e gestire un VpcLink. Configura quindi un metodo API e integralo con il VpcLink impostando HTTP o HTTP_PROXY come il tipo di integrazione, VPC_LINK come il tipo di connessione dell'integrazione e l'identificativo VpcLink per il connectionId dell'integrazione.

Nota

Il load balancer di rete e l'API devono essere di proprietà dello stesso account AWS.

Per iniziare subito a creare un'API per accedere alle risorse VPC, illustreremo le fasi essenziali per la creazione di un'API con l'integrazione privata utilizzando la console API Gateway. Prima di creare l'API, esegui le operazioni seguenti:

1. Crea una risorsa VPC, crea o scegli un Network Load Balancer con il tuo account nella stessa regione e aggiungi l'istanza EC2 che ospita la risorsa come destinazione del Network Load Balancer. Per ulteriori informazioni, consulta Configurazione di un sistema Network Load Balancer per le integrazioni private di API Gateway.

2. Concedi le autorizzazioni per creare i collegamenti VPC per le integrazioni private. Per ulteriori informazioni, consulta Concessione di autorizzazioni per la creazione di un collegamento VPC.

Dopo la creazione della risorsa VPC e del Network Load Balancer con la risorsa VPC configurata nei gruppi di destinazione, segui le istruzioni riportate di seguito per creare un'API e integrala con la risorsa VPC mediante un VpcLink in un'integrazione privata.

Per creare un'API con un'integrazione privata

1. Accedere alla console API Gateway all'indirizzo https://console.aws.amazon.com/apigateway.

2. Se si utilizza API Gateway per la prima volta, verrà visualizzata una pagina che presenta le caratteristiche del servizio. In API REST, scegliere Crea. Quando appare il popup Create Example API (Crea API di esempio), scegliere OK.

   Se non è la prima volta che si utilizza API Gateway, scegliere Create API (Crea API). In API REST, scegliere Crea.

3. Crea una REST API regionale o ottimizzata per edge.

4. Seleziona l'API.

5. Scegli Crea metodo e procedi come descritto di seguito:

   1. In Tipo di metodo, seleziona GET.

   2. In Tipo di integrazione seleziona Collegamento VPC.

   3. Attiva l'opzione Integrazione proxy VPC.

   4. Per Metodo HTTP seleziona GET.

   5. Per Collegamento VPC seleziona [Utilizza le varabili di fase] e immetti ${stageVariables.vpcLinkId} nella casella di testo sottostante.

      Definisci la variabile di fase vpcLinkId dopo l'implementazione dell'API in una fase e imposti il suo valore sull'ID del VpcLink.

   6. Immetti un URL, ad esempio http://myApi.example.com, per URL dell'endpoint.

      Qui viene utilizzato il nome host (ad esempio, myApi.example.com) per impostare l'intestazione Host della richiesta di integrazione.

   7. Scegli Crea metodo.

      Con l'integrazione proxy, l'API è pronta per la distribuzione. In caso contrario, è necessario procedere con la configurazione delle risposte di metodo e delle risposte di integrazione appropriate.

6. Scegli Distribuisci l'API e procedi come indicato di seguito:

   1. In Fase, seleziona Nuova fase.

   2. Per Nome fase immetti il nome di una fase.

   3. (Facoltativo) In Description (Descrizione), immettere una descrizione.

   4. Seleziona Deploy (Implementa).

7. Nella sezione Dettagli fase annota l'URL di richiamata risultante. Ti servirà per invocare l'API. Prima di farlo, dovrai configurare la variabile di fase vpcLinkId.

8. Nel riquadro Fasi scegli la scheda Variabili di fase, quindi procedi come indicato di seguito:

   1. Scegli Gestisci variabili, quindi seleziona Aggiungi variabile di fase.

   2. Per Nome, immetti vpcLinkId.

   3. Per Valore immetti l'ID del VPC_LINK, ad esempio gix6s7.

   4. Seleziona Salva.

      Se utilizzi la variabile di fase, modificandone il valore puoi facilmente passare a collegamenti VPC diversi per l'API.