Inizia a usare la REST API console - Amazon API Gateway

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à.

Inizia a usare la REST API console

In questo esercizio introduttivo, creerai un server serverless REST API utilizzando la console API Gateway RESTAPI. La tecnologia serverless APIs consente di concentrarsi sulle applicazioni anziché dedicare tempo al provisioning e alla gestione dei server. Il completamento di questa esercitazione richiede meno di 20 minuti e rientra nel piano gratuito AWS.

Innanzitutto, crei una funzione Lambda utilizzando la console Lambda. Successivamente, si crea una console REST API utilizzando la console API Gateway RESTAPI. Quindi, crei un API metodo e lo integri con una funzione Lambda utilizzando un'integrazione proxy Lambda. Infine, distribuisci e richiami il tuo. API

Quando richiami la tua RESTAPI, API Gateway indirizza la richiesta alla tua funzione Lambda. Lambda esegue la funzione e restituisce una risposta a API Gateway. APIGateway ti restituisce quindi la risposta.

Panoramica di ciò REST API che crei in questo tutorial.

Per completare questo esercizio, è necessario un utente Account AWS and an AWS Identity and Access Management (IAM) con accesso alla console. Per ulteriori informazioni, consulta Configurazione per l'utilizzo di API Gateway.

Fase 1: creazione di una funzione Lambda

Usi una funzione Lambda per il backend del tuo. API Lambda esegue il codice solo quando è necessario e si dimensiona automaticamente, da poche richieste al giorno a migliaia al secondo.

Per questa esercitazione, utilizzi una funzione Node.js predefinita nella console Lambda.

Per creare una funzione Lambda
  1. Accedi alla console Lambda all'indirizzo https://console.aws.amazon.com /lambda.

  2. Scegli Crea funzione.

  3. In Basic information (Informazioni di base) , per Function name (Nome funzione) , inserisci my-function.

  4. Per tutte le altre opzioni, usa l'impostazione predefinita.

  5. Scegli Crea funzione.

Il codice predefinito della funzione Lambda dovrebbe essere simile al seguente:

export const handler = async (event) => { const response = { statusCode: 200, body: JSON.stringify('The API Gateway REST API console is great!'), }; return response; };

È possibile modificare la funzione Lambda per questo esercizio, purché la risposta della funzione sia in linea con il formato richiesto da Gateway. API

Sostituisci il corpo della risposta predefinito (Hello from Lambda!) con The API Gateway REST API console is great!. Quando richiami la funzione di esempio, restituisce una risposta 200 ai client, insieme alla risposta aggiornata.

Fase 2: Creare un REST API

Successivamente, si crea un REST API file con una risorsa root (/).

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

  2. Esegui una di queste operazioni:

    • Per creare il tuo primo fileAPI, scegli Build. RESTAPI

    • Se ne hai già creato unoAPI, scegli Crea API, quindi scegli Crea per RESTAPI.

  3. Per APInome, inseriscimy-rest-api.

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

  5. Mantieni il tipo di API endpoint impostato su Regionale.

  6. Scegli Crea API.

Fase 3: Creazione di un'integrazione proxy Lambda

Successivamente, crei un API metodo per la tua REST API risorsa root (/) e integri il metodo con la tua funzione Lambda utilizzando un'integrazione proxy. In un'integrazione con proxy Lambda, API Gateway passa la richiesta in entrata dal client direttamente alla funzione Lambda.

Creazione di un'integrazione proxy Lambda
  1. Seleziona la risorsa /, quindi scegli Crea metodo.

  2. In Tipo di metodo, seleziona ANY.

  3. In Tipo di integrazione, seleziona Lambda.

  4. Attiva l'opzione Integrazione proxy Lambda.

  5. In Funzione Lambda, immetti my-function, quindi seleziona la funzione Lambda.

  6. Scegli Crea metodo.

Fase 4: Implementa il API

Successivamente, crei una API distribuzione e la associ a una fase.

Per distribuire il API
  1. Scegliere Deploy (Implementa)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).

Ora i clienti possono chiamare il tuoAPI. Per testarlo API prima di distribuirlo, puoi facoltativamente scegliere il ANYmetodo, accedere alla scheda Test e quindi scegliere Test.

Passaggio 5: richiama il API

Per invocare il tuo API
  1. Nel riquadro di navigazione principale, seleziona Log.

  2. In Dettagli dello stage, scegli l'icona di copia per copiare API la tua chiamataURL.

    Dopo aver creato la tua RESTAPI, la console mostra la tua API URL invoce.
  3. Inserisci l'invoke URL in un browser web.

    La versione completa URL dovrebbe https://abcd123.execute-api.us-east-2.amazonaws.com/Prod assomigliare a.

    Il tuo browser invia una GET richiesta aAPI.

  4. Verifica la tua API risposta. Il testo "The API Gateway REST API console is great!" dovrebbe essere visualizzato nel browser in uso.

(Opzionale) Fase 6: pulizia

Per evitare di incorrere in costi inutili Account AWS, elimina le risorse che hai creato come parte di questo esercizio. I passaggi seguenti eliminano REST API la tua funzione Lambda e le risorse associate.

Per eliminare le tue REST API
  1. Nel riquadro Risorse, scegli APIazioni, Elimina API.

  2. Nella API finestra di dialogo Elimina, immettete conferma, quindi scegliete Elimina.

Eliminazione della funzione Lambda
  1. Accedi alla console Lambda all'indirizzo https://console.aws.amazon.com /lambda.

  2. Nella pagina Funzioni, seleziona la tua funzione. Scegli Operazioni > Elimina.

  3. Nella finestra di dialogo Elimina 1 funzione/i, immetti delete e quindi scegli Elimina.

Eliminazione del gruppo di log della funzione Lambda
  1. Apri la pagina dei gruppi di log della CloudWatch console Amazon.

  2. Nella pagina Gruppi di log, seleziona il gruppo di log della funzione (/aws/lambda/my-function). In Operazioni, scegli Elimina gruppo di log.

  3. Nella finestra di dialogo Delete log group(s) (Elimina gruppo/i di log) scegli Delete (Elimina).

Eliminazione del ruolo di esecuzione della funzione Lambda
  1. Apri la pagina Ruoli della IAM console.

  2. (Facoltativo) Nella pagina Ruoli, nella casella di ricerca, immetti my-function.

  3. Seleziona il ruolo della tua funzione (ad esempio, my-function-31exxmpl), quindi scegli Elimina.

  4. Nella finestra di dialogo Eliminare my-function-31exxmpl?, immetti il nome del ruolo, quindi scegli Elimina.

Suggerimento

È possibile automatizzare la creazione e la pulizia delle AWS risorse utilizzando AWS CloudFormation o AWS Serverless Application Model ()AWS SAM. Per alcuni AWS CloudFormation modelli di esempio, consulta i modelli di esempio per API Gateway nel repository GitHub awsdocs.