Concetti di Amazon API Gateway

La sezione seguente descrive i concetti introduttivi all'uso API di Gateway.

API Gateway

APIGateway è un AWS servizio che supporta quanto segue:

• Creazione, implementazione e gestione di un'interfaccia di programmazione delle RESTfulapplicazioni (API) per esporre HTTP endpoint, AWS Lambda funzioni o altri servizi di backend. AWS

• Creazione, implementazione e gestione di funzioni o altri servizi WebSocketAPIper AWS Lambda esporre. AWS

• Richiamo di API metodi esposti tramite il frontend e gli endpointHTTP. WebSocket

APIGateway REST API

Una raccolta di HTTP risorse e metodi integrati con HTTP endpoint di backend, funzioni Lambda o altri servizi. AWS È possibile distribuire questa raccolta in una o più fasi. In genere, API le risorse sono organizzate in un albero di risorse in base alla logica dell'applicazione. Ogni API risorsa può esporre uno o più API metodi con HTTP verbi univoci supportati da API Gateway. Per ulteriori informazioni, consulta Scegli tra REST APIs e HTTP APIs.

APIGateway HTTP API

Una raccolta di percorsi e metodi integrati con HTTP endpoint di backend o funzioni Lambda. È possibile distribuire questa raccolta in una o più fasi. Ogni route può esporre uno o più API metodi con HTTP verbi univoci supportati da Gateway. API Per ulteriori informazioni, consulta Scegli tra REST APIs e HTTP APIs.

APIGateway WebSocket API

Una raccolta di WebSocket percorsi e chiavi di percorso integrati con HTTP endpoint di backend, funzioni Lambda o altri servizi. AWS È possibile distribuire questa raccolta in una o più fasi. APIi metodi vengono richiamati tramite WebSocket connessioni frontend che è possibile associare a un nome di dominio personalizzato registrato.

APIdistribuzione

Un' point-in-time istantanea del tuo API GatewayAPI. Per essere disponibile per l'uso da parte dei client, l'implementazione deve essere associata a una o più API fasi.

Sviluppatore API

L' AWS account che possiede una distribuzione API Gateway (ad esempio, un fornitore di servizi che supporta anche l'accesso programmatico).

Endpoint API

Un nome host per un API gateway API interno distribuito in una regione specifica. Il formato del nome host è {api-id}.execute-api.{region}.amazonaws.com. Sono supportati i seguenti tipi di API endpoint:

• Endpoint ottimizzato per Edge API

• APIEndpoint privato

• Endpoint regionale API

Chiave API

Una stringa alfanumerica utilizzata da API Gateway per identificare uno sviluppatore di app che utilizza il tuo o. REST WebSocket API APIGateway può generare API chiavi per tuo conto oppure puoi importarle da un CSV file. Puoi utilizzare API le chiavi insieme agli autorizzatori Lambda o ai piani di utilizzo per controllare l'accesso al tuo. APIs

Vedi gli endpointAPI.

APIproprietario

Vedi APIsviluppatore.

APIpalco

Un riferimento logico allo stato del ciclo di vita del tuo API (ad esempio, 'dev', 'prod', 'beta', 'v2'). APIle fasi sono identificate dall'APIID e dal nome della fase.

Sviluppatore di app

Un creatore di app che può avere o meno un AWS account e che interagisce con API quello che tu, lo API sviluppatore, hai distribuito. Gli sviluppatori di app sono i tuoi clienti. Uno sviluppatore di app viene in genere identificato da una API chiave.

Richiamata URL

Quando si connette un nuovo client tramite una WebSocket connessione, è possibile chiamare un'integrazione in API Gateway per memorizzare il callback URL del client. È quindi possibile utilizzare tale callback URL per inviare messaggi al client dal sistema di backend.

Portale per sviluppatori

Un'applicazione che consente ai vostri clienti di registrarsi, scoprire e abbonarsi ai vostri API prodotti (piani di utilizzo API Gateway), gestire API le loro chiavi e visualizzare le metriche di utilizzo relative ai vostri prodotti. APIs

Endpoint ottimizzato per l'edge API

Il nome host predefinito di un API gateway API che viene distribuito nella regione specificata utilizzando una CloudFront distribuzione per facilitare l'accesso dei client, in genere da più regioni. AWS APIle richieste vengono indirizzate al CloudFront Point of Presence (POP) più vicino, il che in genere migliora i tempi di connessione per client geograficamente diversi.

Vedi gli endpoint. API

Richiesta di integrazione

L'interfaccia interna di una WebSocket API route o di un REST API metodo in API Gateway, in cui si mappa il corpo di una richiesta di route o i parametri e il corpo di una richiesta di metodo ai formati richiesti dal backend.

Risposta di integrazione

L'interfaccia interna di un WebSocket API percorso o di un REST API metodo in API Gateway, in cui si mappano i codici di stato, le intestazioni e il payload ricevuti dal backend al formato di risposta restituito a un'app client.

Modello di mappatura

Uno script in Velocity Template Language (VTL) che trasforma il corpo di una richiesta dal formato di dati di frontend al formato di dati di backend o che trasforma un corpo di risposta dal formato di dati di backend al formato di dati frontend. I modelli di mappatura possono essere specificati nella richiesta o nella risposta di integrazione. Possono fare riferimento ai dati disponibili al runtime come contesto e variabili di fase.

La mappatura può essere semplice come una trasformazione di identità che trasferisce le intestazioni o il corpo mediante l'integrazione senza alcuna modifica dal client al back-end per una richiesta. Lo stesso vale per una risposta, in cui il payload viene trasferito dal back-end al client.

Richiesta metodo

L'interfaccia pubblica di un API metodo in API Gateway che definisce i parametri e il corpo che uno sviluppatore di app deve inviare per le richieste di accesso al backend tramite. API

Risposta di metodo

L'interfaccia pubblica di a REST API che definisce i codici di stato, le intestazioni e i modelli di body che uno sviluppatore di app dovrebbe aspettarsi nelle risposte di. API

Integrazione fittizia

In un'integrazione fittizia, API le risposte vengono generate direttamente da API Gateway, senza la necessità di un backend di integrazione. In qualità di API sviluppatore, sei tu a decidere in che modo API Gateway risponde a una richiesta di integrazione fittizia. A tale scopo, è necessario configurare la richiesta e la risposta di integrazione del metodo per associare una risposta a un codice di stato specifico.

Modello

Schema di dati che specifica la struttura di dati di una richiesta o di un payload di risposta. È necessario un modello per generare un file fortemente tipizzatoSDK. API Viene anche utilizzato per convalidare payload. Un modello è utile per generare un modello di mappatura di esempio per avviare la creazione di un modello di mappatura di produzione. Sebbene sia utile, il modello non è richiesto per la creazione di un modello di mappatura.

Privato API

Vedi APIEndpoint privato.

Endpoint privato API

Un API endpoint esposto tramite VPC endpoint di interfaccia e che consente a un client di accedere in modo sicuro alle risorse private API all'interno di un. VPC APIsI privati sono isolati dalla rete Internet pubblica ed è possibile accedervi solo utilizzando gli VPC endpoint for API Gateway a cui è stato concesso l'accesso.

Integrazione privata

Un tipo di integrazione API Gateway che consente a un client di accedere alle risorse interne di un cliente VPC tramite un REST API endpoint privato senza esporre le risorse alla rete Internet pubblica.

Integrazione proxy

Una configurazione di integrazione API Gateway semplificata. Puoi configurare un'integrazione proxy come integrazione HTTP proxy o integrazione proxy Lambda.

Per l'integrazione con il HTTP proxy, API Gateway trasmette l'intera richiesta e risposta tra il frontend e un HTTP backend. Per l'integrazione del proxy Lambda, API Gateway invia l'intera richiesta come input a una funzione Lambda di backend. APIGateway trasforma quindi l'output della funzione Lambda in una HTTP risposta frontend.

In RESTAPIs, l'integrazione proxy viene utilizzata più comunemente con una risorsa proxy, che è rappresentata da una variabile greedy path (ad esempio,{proxy+}) combinata con un metodo catch-allANY.

Creazione rapida

È possibile utilizzare la creazione rapida per semplificare la creazione di un. HTTP API La creazione rapida crea un percorso API con Lambda o HTTP integrazione, un percorso generico predefinito e uno stadio predefinito configurato per distribuire automaticamente le modifiche. Per ulteriori informazioni, consulta Crea un'API HTTP utilizzando la AWS CLI.

Endpoint regionale API

Il nome host di un API dispositivo distribuito nella regione specificata e destinato a servire i client, ad esempio EC2 le istanze, nella stessa regione. AWS APIle richieste vengono indirizzate direttamente al API gateway specifico della regione API senza passare attraverso alcuna distribuzione. CloudFront Per le richieste all'interno della regione, un endpoint regionale aggira l'inutile processo di andata e ritorno verso una distribuzione. CloudFront

Inoltre, è possibile applicare il routing basato sulla latenza sugli endpoint regionali per distribuirlo su più regioni utilizzando la stessa configurazione degli API endpoint regionali, impostare lo stesso nome di dominio personalizzato per ogni dispositivo distribuito API e configurare i DNS record basati sulla latenza in Route 53 per indirizzare le richieste dei client verso la regione con la latenza più bassa. API

Vedi API gli endpoint.

Route

Una WebSocket route in API Gateway viene utilizzata per indirizzare i messaggi in arrivo a un'integrazione specifica, ad esempio una AWS Lambda funzione, in base al contenuto del messaggio. Quando definisci il tuo WebSocket API, specifichi una chiave di percorso e un backend di integrazione. La chiave route è un attributo nel corpo del messaggio. Quando viene trovata una corrispondenza per la chiave route in un messaggio in entrata, viene richiamato il back-end di integrazione.

È anche possibile impostare una route predefinita per chiavi route non corrispondenti o per specificare un modello di proxy che trasferisce il messaggio senza alcuna modifica ai componenti di back-end che eseguono l'instradamento ed elaborano la richiesta.

Richiesta di instradamento

L'interfaccia pubblica di un WebSocket API metodo in API Gateway che definisce il corpo che uno sviluppatore di app deve inviare nelle richieste di accesso al backend tramite. API

Risposta di instradamento

L'interfaccia pubblica di a WebSocket API che definisce i codici di stato, le intestazioni e i modelli di body che uno sviluppatore di app dovrebbe aspettarsi da API Gateway.

Piano di utilizzo

Un piano di utilizzo fornisce a API client selezionati l'accesso a uno o più o più dispositivi distribuitiREST. WebSocket APIs È possibile utilizzare un piano di utilizzo per configurare i limiti di limitazione e quota, che vengono applicati alle singole chiavi client. API

WebSocket connessione

APIGateway mantiene una connessione persistente tra i client e il API Gateway stesso. Non esiste una connessione persistente tra il API gateway e le integrazioni di backend come le funzioni Lambda. I servizi di back-end vengono richiamati in base alle esigenze, a seconda del contenuto dei messaggi ricevuti dai client.