Configurazione di un metodo mediante la console API Gateway

Seleziona il metodo nel riquadro Risorse, quindi scegli la scheda Richiesta metodo.

Nella sezione Impostazioni della richiesta del metodo scegli Modifica.

Per Autorizzazione seleziona un sistema di autorizzazione disponibile.

1. Per abilitare l'accesso aperto al metodo per qualsiasi utente, scegli Nessuno. Questa fase può essere ignorata se l'impostazione predefinita non è stata modificata.

2. Per utilizzare le autorizzazioni IAM per controllare l'accesso del client al metodo, scegli AWS_IAM. In questo modo il metodo potrà essere chiamato solo dagli utenti dei ruoli IAM a cui è collegata la policy IAM corretta.

   Per creare il ruolo IAM, specifica una policy di accesso con un formato simile al seguente:

   {
     "Version": "2012-10-17",
     "Statement": [
       {
         "Effect": "Allow",
         "Action": [
           "execute-api:Invoke"
         ],
         "Resource": [
           "resource-statement"
         ]
       }
     ]
   }  

   In questa policy di accesso, resource-statement è l'ARN del metodo. Per trovare l'ARN del metodo, seleziona il metodo nella pagina Risorse. Per ulteriori informazioni sull'impostazione delle autorizzazioni IAM, consulta Controllo degli accessi a una REST API con le autorizzazioni IAM.

   Per creare il ruolo IAM è possibile adattare le istruzioni disponibili nel tutorial Creazione di una funzione Lambda per l'integrazione non proxy Lambda.

3. Per utilizzare un sistema di autorizzazione Lambda, seleziona un token o un sistema di autorizzazione di richiesta. Affinché questa scelta sia visualizzata nel menu a discesa, è necessario creare un sistema di autorizzazione Lambda. Per informazioni su come creare un'autorizzazione Lambda, consulta Uso di autorizzazioni Lambda di API Gateway.

4. Per utilizzare un pool di utenti di Amazon Cognito, sceglierne uno disponibile in Cognito user pool authorizers (Autorizzazioni pool di utenti Cognito). Affinché questa scelta sia visualizzata nel menu a discesa, è necessario creare un pool di utenti in Amazon Cognito e un'autorizzazione del pool di utenti di Amazon Cognito in API Gateway. Per informazioni su come creare un'autorizzazione del pool di utenti di Amazon Cognito, consulta Controllo degli accessi alle REST API utilizzando pool di utenti di Amazon Cognito come sistema di autorizzazione.

Per specificare la convalida della richiesta, seleziona un valore dal menu a discesa Validatore richiesta. Per disattivare la convalida della richiesta, seleziona Nessuno. Per ulteriori informazioni su ciascuna opzione, consulta Convalida delle richieste per REST API in Gateway API.

Seleziona Chiave API necessaria per richiedere una chiave API. Quando sono abilitate, le chiavi API vengono utilizzate nei piani di utilizzo per limitare il traffico client.

(Facoltativo) Per assegnare un nome di operazione in un SDK Java di questa API generata da Gateway API, immetti un nome in Nome operazione. Ad esempio, per la richiesta del metodo GET /pets/{petId}, il nome di operazione dell'SDK Java corrispondente è GetPetsPetId per impostazione predefinita. Questo nome viene costruito dal verbo HTTP del metodo (GET) e dai nomi delle variabili di percorso della risorsa (Pets e PetId). Se imposti il nome dell'operazione come getPetById, il nome di operazione dell'SDK diventa GetPetById.

Per aggiungere un parametro stringa di query al metodo, procedi come indicato di seguito:

1. Scegli Parametri della stringa di query URL, quindi seleziona Aggiungi stringa di query.

2. In Nome digita il nome del parametro della stringa di query.

3. Se il parametro della stringa di query appena creato viene usato per la convalida della richiesta, scegli l'opzione Obbligatorio. Per ulteriori informazioni sulla convalida della richiesta, consulta Convalida delle richieste per REST API in Gateway API.

4. Se il parametro della stringa di query appena creato viene usato come parte di una chiave di caching, seleziona l'opzione Caching. Per ulteriori informazioni sul caching, consulta Uso dei parametri di metodo o di integrazione come chiavi di cache per indicizzare le risposte memorizzate nella cache.

Per rimuovere il parametro della stringa di query, scegli Rimuovi.

Per aggiungere un parametro di intestazione al metodo, procedi come indicato di seguito:

1. Scegli Intestazioni di richiesta HTTP, quindi seleziona Aggiungi intestazione.

2. Per Nome immetti il nome dell'intestazione.

3. Se l'intestazione appena creata viene usata per la convalida della richiesta, scegli l'opzione Obbligatorio. Per ulteriori informazioni sulla convalida della richiesta, consulta Convalida delle richieste per REST API in Gateway API.

4. Se l'intestazione appena creata viene usata come parte di una chiave di caching, scegli l'opzione Caching. Per ulteriori informazioni sul caching, consulta Uso dei parametri di metodo o di integrazione come chiavi di cache per indicizzare le risposte memorizzate nella cache.

Per rimuovere l'intestazione, scegli Rimuovi.

Per dichiarare il formato del payload di una richiesta di metodo con il verbo HTTP POST, PUT o PATCH, espandi Corpo della richiesta e procedi come segue:

1. Scegliere Add model (Aggiungi modello).

2. Per Content-Type immetti un tipo MIME (ad esempio application/json).

3. Per Modello seleziona un modello dal menu a discesa. I modelli attualmente disponibili per l'API includono i modelli Empty ed Error predefiniti e tutti i modelli creati e aggiunti alla raccolta Models (Modelli) dell'API. Per ulteriori informazioni sulla creazione di un modello, consulta Modelli di dati per REST API.

   Nota

   Il modello è utile per informare il client del formato dati previsto di un payload, nonché per generare un modello di mappatura. È importante generare un SDK tipizzato in modo sicuro dell'API in linguaggi come Java, C#, Objective-C e Swift. È obbligatorio solo se la convalida di richiesta è abilitata per il payload.

Seleziona Salva.

Seleziona il metodo nel riquadro Risorse, quindi scegli la scheda Risposta metodo. Potrebbe essere necessario scegliere il pulsante freccia destra per visualizzare la scheda.

Nella sezione Impostazioni risposta metodo scegli Crea risposta.

Per Codice di stato HTTP inserisci un codice di stato HTTP come 200, 400 o 500.

Se per una risposta restituita dal back-end non è definita una risposta del metodo corrispondente, API Gateway non è in grado di restituire la risposta al client. Restituisce invece una risposta di errore 500 Internal server error.

Seleziona Add header (Aggiungi intestazione).

Per Nome intestazione immetti un nome.

Per restituire un'intestazione dal back-end al client, aggiungi l'intestazione nella risposta del metodo.

Scegli Aggiungi modello per definire un formato del corpo della risposta del metodo.

Immetti il tipo di supporto del payload della risposta per Tipo di contenuto e seleziona un modello dal menu a discesa Modelli.

Seleziona Salva.