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à.
Imposta la convalida delle richieste di base in API Gateway
Questa sezione mostra come configurare la convalida delle richieste per API Gateway utilizzando la console e una definizione apertaAPI. AWS CLI
Argomenti
Imposta la convalida delle richieste utilizzando la API console Gateway
È possibile utilizzare la console API Gateway per convalidare una richiesta selezionando uno dei tre validatori per una richiesta: API
-
Convalida del corpo.
-
Convalida dei parametri e delle intestazioni delle stringhe di query.
-
Convalida del corpo, dei parametri delle stringhe di query e delle intestazioni.
Quando applichi uno dei validatori a un API metodo, la console API Gateway aggiunge il validatore alla mappa. API RequestValidators
Per seguire questo tutorial, utilizzerai un AWS CloudFormation modello per creare un Gateway incompletoAPI. API Questo API ha una /validator
risorsa con GET
e POST
metodi. Entrambi i metodi sono integrati con l'http://petstore-demo-endpoint.execute-api.com/petstore/pets
HTTPendpoint. Configurare due tipi di convalida delle richieste:
-
Nel
GET
metodo, configurerai la convalida della richiesta per i parametri della stringa di URL query. -
Nel metodo
POST
, verrà configurata la convalida delle richieste per il corpo della richiesta.
Ciò consentirà solo a determinate API chiamate di passare a. API
Scarica e decomprimi il modello di creazione dell'app per AWS CloudFormation. Utilizzerai questo modello per crearne uno incompletoAPI. Completerai il resto dei passaggi nella console API Gateway.
Per creare uno AWS CloudFormation stack
Apri la AWS CloudFormation console all'indirizzo https://console.aws.amazon.com/cloudformation
. -
Scegliere Create stack (Crea stack), quindi With new resources (standard) (Con nuove risorse (standard)).
-
In Specificare modello, scegliere Carica un file modello.
-
Selezionare il modello scaricato.
-
Seleziona Successivo.
-
Per Stack name (Nome stack), inserire
request-validation-tutorial-console
, quindi scegliere Next (Avanti). -
Per Configure stack options (Configura opzioni di stack), scegliere Next (Successivo).
-
Per quanto riguarda le funzionalità, riconosci che AWS CloudFormation puoi creare IAM risorse nel tuo account.
-
Scegli Invia.
AWS CloudFormation fornisce le risorse specificate nel modello. Per completare il provisioning delle risorse, potrebbero essere necessari alcuni minuti. Quando lo stato del tuo AWS CloudFormation stack è CREATE_ COMPLETE, sei pronto per passare alla fase successiva.
Per selezionare il tuo appena creato API
Selezionare lo stack
request-validation-tutorial-console
appena creato.Scegliere Resources (Risorse).
In Physical ID, scegli il tuoAPI. Questo collegamento ti indirizzerà alla console API Gateway.
Prima di modificare i metodi GET
e POST
, è necessario creare un modello.
Creazione di un modello
-
È necessario che un modello utilizzi la convalida della richiesta nel corpo di una richiesta in arrivo. Per creare un modello seleziona Modelli nel pannello di navigazione principale.
-
Scegli Crea modello.
-
Per Nome, immetti
PetStoreModel
. -
In Tipo di contenuto, inserire
application/json
. Se non viene trovato alcun tipo di contenuto corrispondente, la convalida della richiesta non viene eseguita. Per utilizzare lo stesso modello indipendentemente dal tipo di contenuti, inserisci$default
. -
Per Descrizione immetti
My PetStore Model
come descrizione del modello. -
Per Schema modello incolla il seguente modello nell'editor di codice e scegli Crea.
{ "type" : "object", "required" : [ "name", "price", "type" ], "properties" : { "id" : { "type" : "integer" }, "type" : { "type" : "string", "enum" : [ "dog", "cat", "fish" ] }, "name" : { "type" : "string" }, "price" : { "type" : "number", "minimum" : 25.0, "maximum" : 500.0 } } }
Per ulteriori informazioni sul modello, consulta Modelli di dati per REST APIs.
Per configurare la convalida della richiesta per un metodo GET
-
Nel riquadro di navigazione principale, scegli Risorse, quindi seleziona il GETmetodo.
-
Nella scheda Richiesta metodo, in Impostazioni richiesta metodo, scegli Modifica.
-
Per Validatore richiesta seleziona Convalida parametri di stringa query e intestazioni.
In Parametri della stringa di URL query, procedi come segue:
Scegliere Add query string (Aggiungi stringa di query).
Per Nome, immetti
petType
.Attiva Campo obbligatorio.
Mantieni disattivata l'opzione Caching.
-
Selezionare Salva.
-
Nella scheda Richiesta di integrazione scegli Modifica in Impostazioni della richiesta di integrazione.
In Parametri della stringa di URL query, procedi come segue:
Scegliere Add query string (Aggiungi stringa di query).
Per Nome, immetti
petType
.In Mappato da, inserire
method.request.querystring.petType
. Questa operazione associapetType
al tipo di animale domestico.Per ulteriori informazioni sulla mappatura dei dati, consultare il tutorial relativo alla mappatura dei dati.
Mantieni disattivata l'opzione Caching.
Selezionare Salva.
Per eseguire il test della convalida della richiesta per il metodo GET
-
Seleziona la scheda Test. Potrebbe essere necessario scegliere il pulsante freccia destra per visualizzare la scheda.
-
In Stringhe di query immetti
petType=dog
e scegli Test. -
Il test del metodo restituirà
200 OK
e un elenco di cani.Per informazioni su come trasformare questi dati di output, consultare il tutorial sulla mappatura dei dati.
-
Rimuovere
petType=dog
e scegliere Test. -
Il test del metodo restituirà un errore
400
con il seguente messaggio di errore:{ "message": "Missing required request parameters: [petType]" }
Per configurare la convalida della richiesta per il metodo POST
-
Nel riquadro di navigazione principale, scegliete Risorse, quindi selezionate il POSTmetodo.
-
Nella scheda Richiesta metodo, in Impostazioni richiesta metodo, scegli Modifica.
-
Per Validatore richiesta seleziona Convalida corpo.
-
In Corpo della richiesta scegli Aggiungi modello.
-
Per Tipo di contenuto
application/json
, immettete, quindi per Modello, selezionate PetStoreModel. Selezionare Salva.
Per eseguire il test della convalida della richiesta per un metodo POST
-
Seleziona la scheda Test. Potrebbe essere necessario scegliere il pulsante freccia destra per visualizzare la scheda.
-
In Corpo della richiesta incolla quanto segue nell'editor di codice:
{ "id": 2, "name": "Bella", "type": "dog", "price": 400 }
Scegli Test (Esegui test).
-
Il test del metodo restituirà
200 OK
e un messaggio di operazione riuscita. -
In Corpo della richiesta incolla quanto segue nell'editor di codice:
{ "id": 2, "name": "Bella", "type": "dog", "price": 4000 }
Scegli Test (Esegui test).
-
Il test del metodo restituirà un errore
400
con il seguente messaggio di errore:{ "message": "Invalid request body" }
Nella parte inferiore dei log del test viene restituito il motivo del corpo della richiesta non valido. In questo caso, il prezzo dell'animale era maggiore del valore massimo specificato nel modello.
Per eliminare una AWS CloudFormation pila
Apri la AWS CloudFormation console all'indirizzo https://console.aws.amazon.com/cloudformation
. -
Seleziona il tuo AWS CloudFormation stack.
-
Scegli Elimina e conferma la tua scelta.
Passaggi successivi
Per informazioni su come trasformare i dati di output ed eseguire ulteriori mappature dei dati, consultare il tutorial sulla mappatura dei dati.
Eseguire il tutorial Configurazione della convalida di base delle richieste in AWS CLI per eseguire passaggi simili utilizzando la AWS CLI.
Imposta la convalida delle richieste di base utilizzando il AWS CLI
È possibile creare un validatore per configurare la convalida della richiesta utilizzando la AWS CLI. Per seguire questo tutorial, utilizzerai un AWS CloudFormation modello per creare un API Gateway API incompleto.
Nota
Questo non è lo stesso AWS CloudFormation modello del tutorial per console.
Utilizzando una risorsa /validator
precedentemente esposta, verranno creati i metodi GET
e POST
. Entrambi i metodi verranno integrati con l'http://petstore-demo-endpoint.execute-api.com/petstore/pets
HTTPendpoint. Verranno configurate le due convalide delle richieste seguenti:
-
Sul
GET
metodo, creerai unparams-only
validatore per convalidare i parametri della stringa di URL query. -
Nel metodo
POST
, verrà creato un validatorebody-only
per convalidare il corpo della richiesta.
Ciò consentirà solo a determinate API chiamate di passare a. API
Per creare una AWS CloudFormation pila
Scarica e decomprimi il modello di creazione dell'app per. AWS CloudFormation
Per completare il tutorial seguente, è necessario disporre della AWS Command Line Interface (AWS CLI) versione 2.
Per i comandi lunghi viene utilizzato un carattere di escape (\
) per dividere un comando su più righe.
Nota
In Windows, alcuni CLI comandi Bash che usi comunemente (comezip
) non sono supportati dai terminali integrati del sistema operativo. Per ottenere una versione integrata su Windows di Ubuntu e Bash, installa il sottosistema Windows per Linux
Usa il seguente comando per creare lo stack. AWS CloudFormation
aws cloudformation create-stack --stack-name request-validation-tutorial-cli --template-body file://request-validation-tutorial-cli.zip --capabilities CAPABILITY_NAMED_IAM
-
AWS CloudFormation fornisce le risorse specificate nel modello. Per completare il provisioning delle risorse, potrebbero essere necessari alcuni minuti. Usa il comando seguente per vedere lo stato del tuo AWS CloudFormation stack.
aws cloudformation describe-stacks --stack-name request-validation-tutorial-cli
-
Quando lo stato dello AWS CloudFormation stack è
StackStatus: "CREATE_COMPLETE"
, usa il seguente comando per recuperare i valori di output pertinenti per i passaggi futuri.aws cloudformation describe-stacks --stack-name request-validation-tutorial-cli --query "Stacks[*].Outputs[*].{OutputKey: OutputKey, OutputValue: OutputValue, Description: Description}"
Di seguito sono riportati i valori di output:
ApiId, che è l'ID per. API Per questo tutorial, l'APIID è
abc123
.ResourceId, che è l'ID della risorsa di validazione in cui sono esposti
POST
i metodiGET
and. Per questo tutorial, l'ID risorsa èefg456
.
Creazione dei validatori della richiesta e importazione di un modello
-
Per utilizzare la convalida della richiesta con la AWS CLI, è necessario un validatore. Usare il seguente comando per creare un validatore che convalidi solo i parametri della richiesta.
aws apigateway create-request-validator --rest-api-id
abc123
\ --no-validate-request-body \ --validate-request-parameters \ --name params-onlyAnnotare l'ID del validatore
params-only
. -
Usare il seguente comando per creare un validatore che convalidi solo il corpo della richiesta.
aws apigateway create-request-validator --rest-api-id
abc123
\ --validate-request-body \ --no-validate-request-parameters \ --name body-onlyAnnotare l'ID del validatore
body-only
. -
È necessario che un modello utilizzi la convalida della richiesta nel corpo di una richiesta in arrivo. Utilizzare il comando seguente per importare un modello.
aws apigateway create-model --rest-api-id
abc123
--name PetStoreModel --description 'My PetStore Model' --content-type 'application/json' --schema '{"type": "object", "required" : [ "name", "price", "type" ], "properties" : { "id" : {"type" : "integer"},"type" : {"type" : "string", "enum" : [ "dog", "cat", "fish" ]},"name" : { "type" : "string"},"price" : {"type" : "number","minimum" : 25.0, "maximum" : 500.0}}}}'Se non viene trovato alcun tipo di contenuto corrispondente, la convalida della richiesta non viene eseguita. Per utilizzare lo stesso modello indipendentemente dal tipo di contenuto, specifica
$default
come chiave.
Creazione dei metodi GET
e POST
-
Utilizzate il comando seguente per aggiungere il
GET
HTTP metodo alla/validate
risorsa. Questo comando crea il metodoGET
, aggiunge il validatoreparams-only
e imposta la stringa di querypetType
come richiesto.aws apigateway put-method --rest-api-id
abc123
\ --resource-idefg456
\ --http-method GET \ --authorization-type "NONE" \ --request-validator-idaaa111
\ --request-parameters "method.request.querystring.petType=true"Utilizzate il comando seguente per aggiungere il
POST
HTTP metodo alla/validate
risorsa. Questo comando crea il metodoPOST
, aggiunge il validatorebody-only
e collega il modello al validatore solo del corpo.aws apigateway put-method --rest-api-id
abc123
\ --resource-idefg456
\ --http-method POST \ --authorization-type "NONE" \ --request-validator-idbbb222
\ --request-models 'application/json'=PetStoreModel -
Utilizzare il comando seguente per configurare la risposta
200 OK
del metodoGET /validate
.aws apigateway put-method-response --rest-api-id
abc123
\ --resource-idefg456
\ --http-method GET \ --status-code 200Utilizzare il comando seguente per configurare la risposta
200 OK
del metodoPOST /validate
.aws apigateway put-method-response --rest-api-id
abc123
\ --resource-idefg456
\ --http-method POST \ --status-code 200 -
Utilizzate il comando seguente per configurare un dispositivo
Integration
con un HTTP endpoint specificato per ilGET /validation
metodo.aws apigateway put-integration --rest-api-id
abc123
\ --resource-idefg456
\ --http-method GET \ --type HTTP \ --integration-http-method GET \ --request-parameters '{"integration.request.querystring.type" : "method.request.querystring.petType"}' \ --uri 'http://petstore-demo-endpoint.execute-api.com/petstore/pets'Utilizzate il comando seguente per impostare un endpoint
Integration
con un HTTP endpoint specificato per ilPOST /validation
metodo.aws apigateway put-integration --rest-api-id
abc123
\ --resource-idefg456
\ --http-method POST \ --type HTTP \ --integration-http-method GET \ --uri 'http://petstore-demo-endpoint.execute-api.com/petstore/pets' -
Utilizzare il comando seguente per configurare una risposta di integrazione per il metodo
GET /validation
.aws apigateway put-integration-response --rest-api-id
abc123
\ --resource-idefg456
\ --http-method GET \ --status-code 200 \ --selection-pattern ""Utilizzare il comando seguente per configurare una risposta di integrazione per il metodo
POST /validation
.aws apigateway put-integration-response --rest-api-id
abc123
\ --resource-idefg456
\ --http-method POST \ --status-code 200 \ --selection-pattern ""
Per testare il API
-
Per testare il metodo
GET
, che eseguirà la convalida della richiesta per le stringhe di query, usare il seguente comando:aws apigateway test-invoke-method --rest-api-id
abc123
\ --resource-idefg456
\ --http-method GET \ --path-with-query-string '/validate?petType=dog'Il risultato restituirà
200 OK
e l'elenco dei cani. -
Utilizzare il seguente comando per eseguire il test senza includere la stringa di query
petType
.aws apigateway test-invoke-method --rest-api-id
abc123
\ --resource-idefg456
\ --http-method GETIl risultato restituirà un errore
400
. -
Per testare il metodo
POST
, che eseguirà la convalida della richiesta per il corpo della richiesta, usare il seguente comando:aws apigateway test-invoke-method --rest-api-id
abc123
\ --resource-idefg456
\ --http-method POST \ --body '{"id": 1, "name": "bella", "type": "dog", "price" : 400 }'Il risultato restituirà
200 OK
e un messaggio di operazione riuscita. -
Usare il seguente comando per testare l'utilizzo di un corpo non valido.
aws apigateway test-invoke-method --rest-api-id
abc123
\ --resource-idefg456
\ --http-method POST \ --body '{"id": 1, "name": "bella", "type": "dog", "price" : 1000 }'Il risultato restituirà un errore
400
, perché il prezzo del cane supera il prezzo massimo definito dal modello.
Per eliminare una AWS CloudFormation pila
Usa il seguente comando per eliminare le tue AWS CloudFormation risorse.
aws cloudformation delete-stack --stack-name request-validation-tutorial-cli
Imposta la convalida delle richieste di base utilizzando una definizione aperta API
È possibile dichiarare un validatore di richiesta a API livello specificando un insieme di x-amazon-apigateway-request-validatori. requestValidator oggetto oggetti nella x-amazon-apigateway-requestoggetto -validators mappa per selezionare quale parte della richiesta verrà convalidata. Nell'esempio Open API definition, ci sono due validatori:
Il validatore
all
, che convalida sia il corpo, mediante il modello di datiRequestBodyModel
, sia i parametri.Il modello di
RequestBodyModel
dati richiede che l'JSONoggetto di input contenga leprice
proprietàname
type
, e. La proprietàname
può essere qualsiasi stringa,type
deve essere uno dei campi dell'enumerazione specificati (["dog", "cat", "fish"]
) eprice
deve essere compreso tra 25 e 500. Il parametroid
non è obbligatorio.Il validatore
param-only
, che convalida solo i parametri.
Per attivare un validatore di richiesta su tutti i metodi di anAPI, specificate una x-amazon-apigateway-requestproprietà -validator proprietà a API livello della API definizione Open. Nell'esempio Open API definition, il all
validatore viene utilizzato su tutti i API metodi, a meno che non venga sovrascritto diversamente. Quando si utilizza un modello per convalidare il corpo, se non viene trovato alcun tipo di contenuto corrispondente, la convalida della richiesta non viene eseguita. Per utilizzare lo stesso modello indipendentemente dal tipo di contenuto, specifica $default
come chiave.
Per attivare un validatore di richieste in un singolo metodo, specificare la proprietà x-amazon-apigateway-request-validator
a livello di metodo. Nell'esempio, Open API definition, il param-only
validatore sovrascrive il validatore sul all
metodo. GET
Per importare l'APIesempio Open in API Gateway, consultate le seguenti istruzioni su o versoImportazione di un'API regionale in API Gateway. Importazione di un'API ottimizzata per l'edge in API Gateway