Tutorial: creazione di una REST API con un'integrazione privata - Gateway Amazon API
Fase 1: Creazione di un servizio Amazon ECSFase 2: Creazione di un link VPCFase 3: Creare un'API RESTFase 4: Testa la tua APIFase 5: distribuzione dell'APIFase 6: Chiama la tua APIFase 7: pulire

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

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

In questo tutorial, crei un'API REST che si connette a un servizio Amazon ECS eseguito in un Amazon VPC. I clienti al di fuori del tuo Amazon VPC possono utilizzare l'API per accedere al tuo servizio Amazon ECS.

Questo tutorial dura circa un'ora. Innanzitutto, utilizzi un CloudFormation modello per creare un servizio Amazon VPC e Amazon ECS. Quindi utilizzi la console API Gateway per creare un collegamento VPC V2. Il link VPC consente ad API Gateway di accedere al servizio Amazon ECS eseguito nel tuo VPC Amazon. Successivamente, crei un'API REST che utilizza il collegamento VPC V2 per connettersi al tuo servizio Amazon ECS. Infine, si esegue il dell'API.

Quando richiami la tua API REST, API Gateway indirizza la richiesta al tuo servizio Amazon ECS tramite il tuo link VPC V2, quindi restituisce la risposta dal servizio.

Nota

Questo tutorial era precedentemente supportato per HTTP APIs e ora è supportato per REST APIs utilizzando VPC link V2.

Panoramica della REST API creata in questo tutorial.

Per completare questo tutorial, sono necessari un AWS account e un AWS Identity and Access Management utente con accesso alla console. Per ulteriori informazioni, consulta Configurazione per l'utilizzo di Gateway API.

Fase 1: Creazione di un servizio Amazon ECS

Amazon ECS è un servizio di gestione dei container che facilita l'esecuzione, l'arresto e la gestione di container Docker in un cluster. In questo tutorial eseguirai il cluster su un'infrastruttura serverless gestita da Amazon ECS.

Scarica e decomprimi questo CloudFormation modello, che crea tutte le dipendenze per il servizio, incluso un Amazon VPC. Si utilizza il modello per creare un servizio Amazon ECS che utilizza un Application Load Balancer.

Per creare uno stack CloudFormation

  1. Apri la CloudFormation console in https://console.aws.amazon.com/cloudformation.

  2. Scegliere Create stack (Crea stack), quindi With new resources (standard) (Con nuove risorse (standard)).

  3. In Specificare modello, scegliere Carica un file modello.

  4. Selezionare il modello scaricato.

  5. Scegli Next (Successivo).

  6. Per Stack name (Nome stack), inserire rest-api-private-integrations-tutorial, quindi scegliere Next (Avanti).

  7. Per Configure stack options (Configura opzioni di stack), scegliere Next (Successivo).

  8. Per quanto riguarda le funzionalità, riconosci che CloudFormation puoi creare risorse IAM nel tuo account.

  9. Scegli Avanti, quindi scegli Invia.

CloudFormation esegue il provisioning del servizio ECS, operazione che può richiedere alcuni minuti. Quando lo stato del tuo CloudFormation stack è CREATE_COMPLETE, sei pronto per passare alla fase successiva.

Un link VPC consente ad API Gateway di accedere alle risorse private in un VPC Amazon. Utilizzi un link VPC per consentire ai clienti di accedere al tuo servizio Amazon ECS tramite la tua API REST.

Per creare un link VPC

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

  2. Nel pannello di navigazione principale scegli Collegamenti VPC e quindi Crea.

    È possibile che per aprire il pannello di navigazione principale sia necessario scegliere l'icona del menu.

  3. Per Scegli una versione di collegamento VPC, seleziona VPC link V2.

  4. In Name (Nome), immettere private-integrations-tutorial.

  5. Per VPC scegliere il VPC creato nella fase 1. Il nome deve iniziare con RestApiStack.

  6. Per Sottoreti, selezionare le due sottoreti private nel VPC. I nomi finiscono con PrivateSubnet.

  7. Per Gruppi di sicurezza seleziona l'ID gruppo che inizia con private-integrations-tutorial e ha la descrizione RestApiStack/RestApiTutorialService/Service/SecurityGroup.

  8. Scegli Create (Crea).

Dopo aver creato il tuo VPC link V2, API Gateway fornisce interfacce di rete elastiche per accedere al tuo VPC. Il processo può richiedere alcuni minuti. Nel frattempo, puoi creare la tua API.

Fase 3: Creare un'API REST

L'API REST fornisce un endpoint HTTP per il tuo servizio Amazon ECS.

Creazione di una REST API

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

  2. Scegli Create API (Crea API), quindi per API REST, scegli Build (Crea).

  3. Per Nome, immetti private-integration-api.

  4. Per il tipo di indirizzo IP, selezionare. IPv4

  5. Seleziona Create API (Crea API).

    Dopo aver creato l'API, crei un metodo.

  6. 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 il collegamento VPC, scegli il collegamento VPC V2 che hai creato nel passaggio precedente.

    6. Per Integration Target, inserisci il load balancer che hai creato con il CloudFormation modello nel passaggio 1. Il nome dovrebbe iniziare con rest-.

    7. Per URL dell'endpoint immetti http://private-integrations-tutorial.com.

      L'URL viene utilizzato per impostare l'Hostintestazione della richiesta di integrazione. In questo caso, l'intestazione dell'host è. private-integrations-tutorial

    8. Scegli Crea metodo.

      Con l'integrazione del proxy, l'API è pronta per essere testata.

Fase 4: Testa la tua API

Successivamente, provi a richiamare il metodo API.

Per testare l'API

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

  2. Scegliere l'API.

  3. Seleziona la scheda Test. Potrebbe essere necessario scegliere il pulsante freccia destra per visualizzare la scheda.

  4. Scegli Test

    Verifica che la risposta della tua API sia un messaggio di benvenuto che indica che la tua app è in esecuzione su Amazon ECS.

Fase 5: distribuzione dell'API

Successivamente, distribuisci la tua API.

Per distribuire l'API

  1. Seleziona Deploy API (Distribuisci API).

  2. In Fase, seleziona Nuova fase.

  3. In Stage name (Nome fase) immettere Prod.

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

  5. Seleziona Deploy (Implementa).

Fase 6: Chiama la tua API

Dopo aver distribuito l'API, puoi chiamarla.

Per chiamare la tua API

  1. Immetti l'URL di richiamo in un browser Web.

    L'URL completo dovrebbe essere del tipo https://abcd123.execute-api.us-east-2.amazonaws.com/Prod.

    Il tuo browser invia una richiesta GET all'API.

  2. Verifica che la risposta della tua API sia un messaggio di benvenuto che indica che la tua app è in esecuzione su Amazon ECS.

    Se vedi il messaggio di benvenuto, significa che hai creato con successo un servizio Amazon ECS che viene eseguito in un Amazon VPC e hai utilizzato un'API API Gateway REST con un collegamento VPC V2 per accedere al servizio Amazon ECS.

Fase 7: pulire

Per evitare costi non necessari, eliminare le risorse create nell'ambito di questo tutorial. I passaggi seguenti eliminano il collegamento VPC V2, lo CloudFormation stack e l'API REST.

Per eliminare un'API REST

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

  2. Nella APIspagina, seleziona un'API. Scegliere Azioni, scegliere Elimina, quindi confermare la scelta.

Per eliminare un link VPC

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

  2. Scegliere link VPC.

  3. Selezionare il link VPC, scegliere Elimina, quindi confermare la scelta.

Per eliminare uno stack CloudFormation

  1. Apri la CloudFormation console in https://console.aws.amazon.com/cloudformation.

  2. Seleziona il tuo stack. CloudFormation

  3. Scegli Elimina e conferma la tua scelta.