Scheinintegrationen für REST-APIs in API Gateway

Amazon API Gateway unterstützt die Mock-Integration von API-Methoden. Diese Funktion ermöglicht es API-Entwicklern, API-Antworten direkt von API Gateway zu generieren, ohne ein Integrations-Backend zu benötigen. Als API-Developer können Sie diese Funktion nutzen, um abhängige Teams zu entsperren, die noch vor Beendigung der Projektentwicklung mit der API arbeiten müssen. Zudem lässt sich mit dieser Funktion eine Startseite für die API bereitstellen, die eine Übersicht über die API und die Navigation zu dieser bietet. Ein Beispiel für eine solche Startseite finden Sie in der Integrationsanforderung und -antwort der GET-Methode für die Stammressource der Beispiel-API unter Tutorial: Erstellen einer REST-API durch Importieren eines Beispiels.

Als API-Entwickler entscheiden Sie, wie API Gateway auf eine Mock-Integrationsanfrage antwortet. Dazu konfigurieren Sie die Integrationsanforderung und -antwort der Methode, um einer Antwort einen bestimmten Statuscode zuzuweisen. Damit eine Methode mit Mock-Integration eine 200-Antwort zurückgibt, konfigurieren Sie die Text-Mapping-Vorlage der Integrationsanforderung so, dass Folgendes zurückgegeben wird.

{"statusCode": 200}

Konfigurieren Sie eine 200-Integrationsantwort für folgende Text-Mapping-Vorlage, zum Beispiel:

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

Damit die Methode beispielsweise eine 500-Fehlerantwort zurückgibt, richten Sie dem entsprechend die Text-Mapping-Vorlage der Integrationsanforderung so ein, dass Folgendes zurückgegeben wird.

{"statusCode": 500}

Richten Sie eine 500-Integrationsantwort beispielsweise mit der folgenden Mapping-Vorlage ein:

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

Alternativ können Sie eine Methode der Mock-Integration die standardmäßige Integrationsantwort zurückgeben lassen, ohne die Mapping-Vorlage der Integrationsanforderung zu definieren. Die standardmäßige Integrationsantwort ist die mit einem nicht definierten HTTP status regex. Stellen Sie sicher, dass geeignete Pass-Through-Verhaltensweisen festgelegt wurden.

Anmerkung

Mock-Integrationen sind nicht für die Unterstützung großer Antwortvorlagen vorgesehen. Wenn Sie sie für Ihren Anwendungsfall benötigen, sollten Sie stattdessen die Verwendung einer Lambda-Integration in Betracht ziehen.

Mit der Mapping-Vorlage einer Integrationsanforderung können Sie Anwendungslogik einbringen, um basierend auf bestimmten Bedingungen zu entscheiden, welche Mock-Integrationsantwort zurückgegeben wird. Sie können bei der eingehenden Anforderung beispielsweise einen scope-Abfrageparameter verwenden, um zu bestimmen, ob eine Erfolgs- oder Fehlerantwort zurückgegeben wird:

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

Auf diese Weise lässt die Methode der Mock-Integration interne Aufrufe durch und lehnt andere Aufruftypen mit einer Fehlermeldung ab.

In diesem Abschnitt wird beschrieben, wie die API Gateway-Konsole verwendet wird, um die Mock-Integration für eine API-Methode zu ermöglichen.

Themen

• Mock-Integration mit der API Gateway-Konsole aktivierten