Integrazioni fittizie per le API REST in API Gateway

Amazon API Gateway supporta le integrazioni fittizie per i metodi API. Questa caratteristica permette agli sviluppatori di API di generare risposte API da API Gateway direttamente, senza che sia necessario un back-end di integrazione. Uno sviluppatore di API può usare questa caratteristica per sbloccare team dipendenti che devono lavorare a un'API prima che lo sviluppo del progetto sia completato. Puoi anche usare questa caratteristica per allestire una pagina di destinazione per l'API, con una panoramica e comandi di navigazione per l'API. Per un esempio di pagina di destinazione di questo tipo, consulta la richiesta e la risposta di integrazione del metodo GET nella risorsa root dell'API di esempio illustrata in Tutorial: creazione di un'API REST mediante l'importazione di un esempio.

Uno sviluppatore di API può decidere in che modo API Gateway risponde alle richieste di integrazione fittizia. A tale scopo, è necessario configurare la richiesta e la risposta di integrazione del metodo per associare una risposta a un codice di stato specifico. Affinché un metodo con l'integrazione fittizia restituisca una risposta 200, configura il modello di mappatura del corpo della richiesta di integrazione per restituire quanto segue.

{"statusCode": 200}

Configura una risposta di integrazione 200 con il modello di mappatura del corpo seguente, ad esempio:

{
    "statusCode": 200,
    "message": "Go ahead without me."
}

Analogamente, affinché il metodo restituisca, ad esempio, una risposta di errore 500, configura il modello di mappatura del corpo della richiesta di integrazione per restituire quanto segue.

{"statusCode": 500}

Configura, ad esempio, una risposta di integrazione 500 con il modello di mappatura seguente:

{
    "statusCode": 500,
    "message": "The invoked method is not supported on the API resource."
}

In alternativa, puoi fare in modo che un metodo dell'integrazione fittizia restituisca la risposta di integrazione predefinita senza definire il modello di mappatura della richiesta di integrazione. La risposta di integrazione predefinita è quella con valore HTTP status regex (Regex stato HTTP) non definito. Assicurati che siano impostati i comportamenti di passthrough appropriati.

Nota

Le integrazioni fittizie non sono concepite per supportare modelli di risposta di grandi dimensioni. Se ne hai bisogno per il caso d'uso specifico, dovresti valutare invece l'utilizzo di un'integrazione Lambda.

Usando un modello di mappatura della richiesta di integrazione puoi inserire la logica dell'applicazione per stabilire quale risposta di integrazione fittizia restituire in base a determinate condizioni. Puoi ad esempio usare un parametro di query scope nella richiesta in ingresso per determinare se restituire una risposta di esito positivo o di errore:

{
  #if( $input.params('scope') == "internal" )
    "statusCode": 200
  #else
    "statusCode": 500
  #end
}

In questo modo, il metodo dell'integrazione fittizia consente alle chiamate interne di passare, mentre gli altri tipi di chiamate vengono rifiutati con una risposta di errore.

Questa sezione descrive come utilizzare la console API Gateway per abilitare l'integrazione fittizia per un metodo API.

Argomenti

• Abilitazione dell'integrazione fittizia tramite la console API Gateway