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à.
Utilizzo di un modello di mappatura per sostituire i parametri di richiesta e risposta e i codici di stato di un'API
I modelli di mappatura dei parametri e del codice di risposta di API Gateway standard consentono di mappare i parametri one-to-one e mappare una famiglia di codici di stato di risposta di integrazione, abbinati a un'espressione regolare, a un unico codice di stato di risposta. Le sostituzioni dei modelli di mappatura consentono di effettuare le seguenti operazioni.
-
Esegui mappature many-to-one dei parametri
-
Sostituire i parametri dopo l'applicazione delle mappature standard di Gateway API
-
Mappare i parametri in modo condizionale in base al contenuto del corpo o ad altri valori dei parametri
-
Creare nuovi parametri in modo programmatico
-
Sostituire i codici di stato restituiti dall'endpoint di integrazione
Qualsiasi tipo di parametro di richiesta, intestazione di risposta o codice di stato della risposta può essere sostituito.
Casi d'uso per sostituire i parametri di richiesta e risposta e i codici di stato dell'API
Nella tua API puoi utilizzare una sostituzione del modello di mappatura per fare in modo che l'API esegua le seguenti operazioni.
-
Per creare una nuova intestazione (o sostituire un'intestazione esistente) come una concatenazione di due parametri
-
Per sovrascrivere il codice di risposta in a un codice di esito positivo o di errore in base al contenuto del corpo
-
Per rimappare con riserva un parametro in base al suo contenuto o al contenuto di alcuni altri parametri
-
Per eseguire iterazioni sul contenuto di un corpo json e rimappare coppie chiave-valore a intestazioni o stringhe di query
Considerazioni per sostituire i parametri di richiesta e risposta e i codici di stato dell'API
Le seguenti considerazioni potrebbero influire sull'utilizzo delle sostituzioni dei modelli di mappatura.
-
Le sovrascritture modello di mappatura non possono essere utilizzate con endpoint di integrazione proxy, che sono privi di mappature dati. Per ulteriori informazioni sui tipi di integrazione, consulta Scegliere un tipo di integrazione API Gateway API.
-
Le sovrascritture sono finali. Una sovrascrittura può essere applicata a ciascun parametro una sola volta. Se si prova a sovrascrivere lo stesso parametro più volte, Gateway API restituisce una risposta
5XX. Se occorre sovrascrivere lo stesso parametro più volte in tutto il modello, ti consigliamo di creare una variabile e applicare la sovrascrittura alla fine del modello. Il modello viene applicato solo dopo che l'intero modello è stato analizzato. Per ulteriori informazioni, consulta Sostituisci i parametri e le intestazioni di richiesta di un'API utilizzando AWS Management Console
Informazioni di riferimento sulle sostituzioni dei modelli di mappatura
Per creare una sovrascrittura modello di mappatura, utilizza una o più delle seguenti variabili$context in un modello di mappatura:
| Modello di mappatura corpo della richiesta | Modello di mappatura corpo della risposta |
|---|---|
$context.requestOverride.header. |
$context.responseOverride.header. |
$context.requestOverride.path. |
$context.responseOverride.status |
$context.requestOverride.querystring. |
Nessuno |
Per esempi di sostituzione dei parametri di richiesta e di risposta e dei codici di stato di un'API, consulta Esempi di sostituzione dei parametri di richiesta e di risposta e dei codici di stato di un'API.
