Sviluppo di REST API in Gateway API
In Amazon API Gateway è possibile creare un'API REST come una raccolta di entità programmabili note come risorse di API Gateway. Ad esempio, puoi usare una risorsa RestApi per rappresentare un'API che può contenere una raccolta di entità Resource.
Ciascuna entità Resource
può presentare una o più risorse Method. La risorsa Method
è una richiesta in ingresso inviata dal client ed è espressa nel corpo e nei parametri della richiesta. Definisce l'interfaccia di programmazione delle applicazioni che consente al client di accedere all'oggetto Resource
esposto. Per integrare Method
con un endpoint di backend, noto anche come endpoint di integrazione, devi creare una risorsa Integrazione. In questo modo la richiesta in arrivo viene inoltrata all'URI dell'endpoint di integrazione specificato. Se necessario, puoi trasformare il corpo o i parametri della richiesta in modo da soddisfare i requisiti del backend.
Per le risposte, è possibile creare una risorsa MethodResponse per rappresentare una risposta di richiesta ricevuta dal client e una risorsa IntegrationResponse per rappresentare la risposta di richiesta restituita dal back-end. Puoi configurare la risposta di integrazione per trasformare i dati della risposta di back-end prima di restituire i dati al client o passare la risposta di back-end al client senza modificarla.
Per aiutare i clienti a comprendere l'API, puoi anche fornire la documentazione relativa all'API durante o dopo la sua creazione. A questo scopo, aggiungi una risorsa DocumentationPart per un'entità API supportata.
Per controllare il modo in cui i client chiamano un'API, usa le autorizzazioni IAM, un'autorizzazione Lambda o un pool di utenti di Amazon Cognito. Per misurare l'uso dell'API, configura piani di utilizzo per eseguire il throttling delle richieste API. Puoi abilitare queste impostazioni durante la creazione o l'aggiornamento dell'API.
Per un'introduzione su come creare un'API, consulta Tutorial: creazione di una REST API con un'integrazione proxy Lambda. Per ulteriori informazioni sulle funzionalità di Gateway API che potresti utilizzare durante lo sviluppo di una REST API, consulta i seguenti argomenti. Questi argomenti contengono informazioni concettuali e procedure che puoi eseguire utilizzando la console Gateway API, la REST API di Gateway API, l'interfaccia AWS CLI o uno degli SDK AWS.
Argomenti
- Tipi di endpoint API per REST API in Gateway API
- Metodi per REST API in Gateway API
- Controllo e gestione degli accessi alle REST API in Gateway API
- Integrazioni per REST API in Gateway API
- Convalida delle richieste per REST API in Gateway API
- Trasformazioni dei dati per REST API in Gateway API
- Risposte del gateway per REST API in Gateway API
- CORS per REST API in Gateway API
- Tipi di supporti binari per REST API in Gateway API
- Invocazione di REST API in Gateway API
- Sviluppo di REST API utilizzando OpenAPI in Gateway API