Utilizza un modello di mappatura per sovrascrivere i parametri API di richiesta e risposta e i codici di stato di an

I modelli di mappatura dei parametri e dei codici di risposta Standard di API Gateway 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 dei parametri many-to-one

• Sostituisci i parametri dopo aver applicato le mappature standard del API Gateway

• Mappa i parametri in modo condizionale in base al contenuto del corpo o ad altri valori dei parametri

• Crea nuovi parametri a livello di codice

• Sostituisci 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 sovrascritto.

Casi d'uso per sovrascrivere i parametri API di richiesta e risposta e i codici di stato

Nel tuoAPI, potresti utilizzare un modello di mappatura sostitutivo per API eseguire 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 sovrascrivere i parametri API di richiesta e risposta e i codici di stato dell'utente

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 tenta di sovrascrivere lo stesso parametro più volte, API Gateway 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 l'analisi dell'intero modello. Per ulteriori informazioni, consulta Sostituisci i parametri e API le intestazioni della richiesta di an utilizzando AWS Management Console

Il modello di mappatura sostituisce il riferimento

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.header_name	$context.responseOverride.header.header_name
$context.requestOverride.path.path_name	$context.responseOverride.status
$context.requestOverride.querystring.querystring_name	Nessuno

Per esempi di sovrascrittura dei parametri API di richiesta e risposta e dei codici di stato di an, vedi. Esempi di sovrascrittura dei parametri API di richiesta e risposta e dei codici di stato di an