Beispiele für die Parameterzuweisung für REST APIs in API Gateway

Fokusmodus

Beispiele für die Parameterzuweisung für REST APIs in API Gateway - Amazon API Gateway

Beispiel 1: Ordnen Sie einen Methodenanforderungsparameter einem Integrationsanforderungsparameter zu Beispiel 2: Ordnen Sie mehrere Methodenanforderungsparameter verschiedenen Integrationsanforderungsparametern zu Beispiel 3: Ordnen Sie Felder aus dem Hauptteil der JSON-Anforderung den Parametern der Integrationsanfrage zu Beispiel 4: Ordnen Sie die Integrationsantwort der Methodenantwort zu

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Die folgenden Beispiele zeigen, wie Ausdrücke für die Parameterzuweisung mithilfe der API Gateway Gateway-Konsole, OpenAPI und AWS CloudFormation Vorlagen erstellt werden. Ein Beispiel für die Verwendung der Parameterzuordnung zur Erstellung der erforderlichen CORS-Header finden Sie unter. CORS für REST APIs im API Gateway

Beispiel 1: Ordnen Sie einen Methodenanforderungsparameter einem Integrationsanforderungsparameter zu

Im folgenden Beispiel wird der Header-Parameter der Methodenanforderung puppies dem Header-Parameter der Integrationsanforderung zugeordnetDogsAge0.

AWS Management Console

Um den Methodenanforderungsparameter zuzuordnen

Melden Sie sich bei der API Gateway Gateway-Konsole unter https://console.aws.amazon.com/apigatewayan.
Wählen Sie eine REST-API aus.
Wählen Sie eine Methode.

Ihre Methode muss über eine Nicht-Proxy-Integration verfügen.
Wählen Sie für Einstellungen für Methodenanfragen die Option Bearbeiten aus.
Wählen Sie HTTP-Anforderungs-Headers aus.
Wählen Sie Add header.
Geben Sie unter Name puppies ein.
Wählen Sie Save (Speichern) aus.
Wählen Sie die Registerkarte Integrationsanfrage aus und klicken Sie dann unter Einstellungen für Integrationsanforderungen auf Bearbeiten.

Das fügt AWS Management Console automatisch eine Parameterzuordnung von method.request.header.puppies bis puppies für Sie hinzu, aber Sie müssen den Namen ändern, damit er dem Anforderungsheader-Parameter entspricht, der von Ihrem Integrationsendpunkt erwartet wird.
Geben Sie unter Name DogsAge0 ein.
Wählen Sie Save (Speichern) aus.
Sie müssen Ihre API erneut bereitstellen, damit die Änderungen wirksam werden.

Die folgenden Schritte zeigen Ihnen, wie Sie überprüfen können, ob Ihre Parameterzuordnung erfolgreich war.

(Optional) Testen Sie Ihre Parameterzuordnung

Wählen Sie die Registerkarte Test. Möglicherweise müssen Sie die rechte Pfeiltaste wählen, um die Registerkarte anzuzeigen.
Geben Sie puppies:true für Header ein.
Wählen Sie Test aus.

In den Protokollen sollte das Ergebnis wie folgt aussehen:


Tue Feb 04 00:28:36 UTC 2025 : Method request headers: {puppies=true}
Tue Feb 04 00:28:36 UTC 2025 : Method request body before transformations: 
Tue Feb 04 00:28:36 UTC 2025 : Endpoint request URI: http://petstore-demo-endpoint.execute-api.com/petstore/pets
Tue Feb 04 00:28:36 UTC 2025 : Endpoint request headers: {DogsAge0=true, x-amzn-apigateway-api-id=abcd1234, Accept=application/json, User-Agent=AmazonAPIGateway_aaaaaaa, X-Amzn-Trace-Id=Root=1-abcd-12344}

Der Header-Parameter der Anfrage wurde von puppies zu geändertDogsAge0.

AWS CloudFormation

In diesem Beispiel verwenden Sie die Eigenschaft body, um eine OpenAPI-Definitionsdatei in API Gateway zu importieren.


AWSTemplateFormatVersion: 2010-09-09
Resources:
  Api:
    Type: 'AWS::ApiGateway::RestApi'
    Properties:
      Body:
        openapi: 3.0.1
        info:
          title: ParameterMappingExample
          version: "2025-02-04T00:30:41Z"
        paths:
          /pets:
            get:
              parameters:
                - name: puppies
                  in: header
                  schema:
                    type: string
              responses:
                "200":
                  description: 200 response
              x-amazon-apigateway-integration:
                httpMethod: GET
                uri: http://petstore-demo-endpoint.execute-api.com/petstore/pets
                responses:
                  default:
                    statusCode: "200"
                requestParameters:
                  integration.request.header.DogsAge0: method.request.header.puppies
                passthroughBehavior: when_no_match
                type: http
  ApiGatewayDeployment:
    Type: 'AWS::ApiGateway::Deployment'
    DependsOn: Api 
    Properties: 
      RestApiId: !Ref Api
  ApiGatewayDeployment20250219:
    Type: 'AWS::ApiGateway::Deployment'
    DependsOn: Api 
    Properties: 
      RestApiId: !Ref Api
  Stage:
    Type: 'AWS::ApiGateway::Stage'
    Properties:
       DeploymentId: !Ref ApiGatewayDeployment20250219
       RestApiId: !Ref Api
       StageName: prod

OpenAPI


{
  "openapi" : "3.0.1",
  "info" : {
    "title" : "ParameterMappingExample",
    "version" : "2025-02-04T00:30:41Z"
  },
  "paths" : {
    "/pets" : {
      "get" : {
        "parameters" : [ {
          "name" : "puppies",
          "in" : "header",
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "200 response"
          }
        },
        "x-amazon-apigateway-integration" : {
          "httpMethod" : "GET",
          "uri" : "http://petstore-demo-endpoint.execute-api.com/petstore/pets",
          "responses" : {
            "default" : {
              "statusCode" : "200"
            }
          },
          "requestParameters" : {
            "integration.request.header.DogsAge0" : "method.request.header.puppies"
          },
          "passthroughBehavior" : "when_no_match",
          "type" : "http"
        }
      }
    }
  }
}

anchor anchor anchor

Um den Methodenanforderungsparameter zuzuordnen

Melden Sie sich bei der API Gateway Gateway-Konsole unter https://console.aws.amazon.com/apigatewayan.
Wählen Sie eine REST-API aus.
Wählen Sie eine Methode.

Ihre Methode muss über eine Nicht-Proxy-Integration verfügen.
Wählen Sie für Einstellungen für Methodenanfragen die Option Bearbeiten aus.
Wählen Sie HTTP-Anforderungs-Headers aus.
Wählen Sie Add header.
Geben Sie unter Name puppies ein.
Wählen Sie Save (Speichern) aus.
Wählen Sie die Registerkarte Integrationsanfrage aus und klicken Sie dann unter Einstellungen für Integrationsanforderungen auf Bearbeiten.

Das fügt AWS Management Console automatisch eine Parameterzuordnung von method.request.header.puppies bis puppies für Sie hinzu, aber Sie müssen den Namen ändern, damit er dem Anforderungsheader-Parameter entspricht, der von Ihrem Integrationsendpunkt erwartet wird.
Geben Sie unter Name DogsAge0 ein.
Wählen Sie Save (Speichern) aus.
Sie müssen Ihre API erneut bereitstellen, damit die Änderungen wirksam werden.

Die folgenden Schritte zeigen Ihnen, wie Sie überprüfen können, ob Ihre Parameterzuordnung erfolgreich war.

(Optional) Testen Sie Ihre Parameterzuordnung

Wählen Sie die Registerkarte Test. Möglicherweise müssen Sie die rechte Pfeiltaste wählen, um die Registerkarte anzuzeigen.
Geben Sie puppies:true für Header ein.
Wählen Sie Test aus.

In den Protokollen sollte das Ergebnis wie folgt aussehen:


Tue Feb 04 00:28:36 UTC 2025 : Method request headers: {puppies=true}
Tue Feb 04 00:28:36 UTC 2025 : Method request body before transformations: 
Tue Feb 04 00:28:36 UTC 2025 : Endpoint request URI: http://petstore-demo-endpoint.execute-api.com/petstore/pets
Tue Feb 04 00:28:36 UTC 2025 : Endpoint request headers: {DogsAge0=true, x-amzn-apigateway-api-id=abcd1234, Accept=application/json, User-Agent=AmazonAPIGateway_aaaaaaa, X-Amzn-Trace-Id=Root=1-abcd-12344}

Der Header-Parameter der Anfrage wurde von puppies zu geändertDogsAge0.

Beispiel 2: Ordnen Sie mehrere Methodenanforderungsparameter verschiedenen Integrationsanforderungsparametern zu

Im folgenden Beispiel wird der Abfragezeichenfolge-Parameter methodRequestQueryParam für die Methodenanforderung mit mehreren Werten dem Abfragezeichenfolgenparameter der Integrationsanforderung integrationQueryParam und der Header-Parameter der Methodenanforderung dem Parameter methodRequestHeaderParam für den Pfad der Integrationsanforderung zugeordnet. integrationPathParam

AWS Management Console

Um die Anforderungsparameter der Methode zuzuordnen

Melden Sie sich bei der API Gateway Gateway-Konsole unter https://console.aws.amazon.com/apigatewayan.
Wählen Sie eine REST-API aus.
Wählen Sie eine Methode.

Ihre Methode muss über eine Nicht-Proxy-Integration verfügen.
Wählen Sie für Einstellungen für Methodenanfragen die Option Bearbeiten aus.
Klicken Sie auf Parameter für URL-Abfragezeichenfolgen.
Wählen Sie Abfragezeichenfolge hinzufügen aus.
Geben Sie unter Name methodRequestQueryParam ein.
Wählen Sie HTTP-Anforderungs-Headers aus.
Wählen Sie Add header.
Geben Sie unter Name methodRequestHeaderParam ein.
Wählen Sie Save (Speichern) aus.
Wählen Sie die Registerkarte Integrationsanfrage aus und klicken Sie dann unter Einstellungen für Integrationsanforderungen auf Bearbeiten.
Klicken Sie auf URL-Pfadparameter.
Klicken Sie auf Pfadparameter hinzufügen.
Geben Sie unter Name integrationPathParam ein.
Geben Sie für Zugeordnet von method.request.header.methodRequestHeaderParam ein.

Dadurch wird der Methodenanforderungsheader, den Sie in der Methodenanforderung angegeben haben, einem neuen Pfadparameter für die Integrationsanforderung zugeordnet.
Klicken Sie auf Parameter für URL-Abfragezeichenfolgen.
Wählen Sie Abfragezeichenfolge hinzufügen aus.
Geben Sie unter Name integrationQueryParam ein.
Geben Sie für Zugeordnet von method.request.multivaluequerystring.methodRequestQueryParam ein.

Dadurch wird der mehrwertige Abfragezeichenfolgenparameter einem neuen einwertigen Abfragezeichenfolgenparameter für die Integrationsanforderung zugeordnet.
Wählen Sie Save (Speichern) aus.
Sie müssen Ihre API erneut bereitstellen, damit die Änderungen wirksam werden.

AWS CloudFormation

In diesem Beispiel verwenden Sie die Eigenschaft body, um eine OpenAPI-Definitionsdatei in API Gateway zu importieren.

Die folgende OpenAPI-Definition erstellt die folgenden Parameterzuordnungen für eine HTTP-Integration:

Der Header der Methodenanforderung, benanntmethodRequestHeaderParam, in den Pfadparameter der Integrationsanforderung, benannt integrationPathParam
Die benannte methodRequestQueryParam Abfragezeichenfolge der mehrwertigen Methodenanforderung in die Abfragezeichenfolge der Integrationsanforderung mit dem Namen integrationQueryParam


AWSTemplateFormatVersion: 2010-09-09
Resources:
  Api:
    Type: 'AWS::ApiGateway::RestApi'
    Properties:
      Body: 
        openapi: 3.0.1
        info:
          title: Parameter mapping example 2
          version: "2025-01-15T19:12:31Z"
        paths:
          /:
            post:
              parameters:
                - name: methodRequestQueryParam
                  in: query
                  schema:
                    type: string
                - name: methodRequestHeaderParam
                  in: header
                  schema:
                    type: string
              responses:
                "200":
                  description: 200 response
              x-amazon-apigateway-integration:
                httpMethod: GET
                uri: http://petstore-demo-endpoint.execute-api.com/petstore/pets
                responses:
                  default:
                    statusCode: "200"
                requestParameters:
                  integration.request.querystring.integrationQueryParam: method.request.multivaluequerystring.methodRequestQueryParam
                  integration.request.path.integrationPathParam: method.request.header.methodRequestHeaderParam
                requestTemplates:
                  application/json: '{"statusCode": 200}'
                passthroughBehavior: when_no_templates
                timeoutInMillis: 29000
                type: http
  ApiGatewayDeployment:
    Type: 'AWS::ApiGateway::Deployment'
    DependsOn: Api 
    Properties: 
      RestApiId: !Ref Api
  ApiGatewayDeployment20250219:
    Type: 'AWS::ApiGateway::Deployment'
    DependsOn: Api 
    Properties: 
      RestApiId: !Ref Api
  Stage:
    Type: 'AWS::ApiGateway::Stage'
    Properties:
       DeploymentId: !Ref ApiGatewayDeployment20250219
       RestApiId: !Ref Api
       StageName: prod

OpenAPI

Die folgende OpenAPI-Definition erstellt die folgenden Parameterzuordnungen für eine HTTP-Integration:

Der Header der Methodenanforderung, benanntmethodRequestHeaderParam, in den Pfadparameter der Integrationsanforderung, benannt integrationPathParam
Die benannte methodRequestQueryParam Abfragezeichenfolge der mehrwertigen Methodenanforderung in die Abfragezeichenfolge der Integrationsanforderung mit dem Namen integrationQueryParam


{
  "openapi" : "3.0.1",
  "info" : {
    "title" : "Parameter mapping example 2",
    "version" : "2025-01-15T19:12:31Z"
  },
  "paths" : {
    "/" : {
      "post" : {
        "parameters" : [ {
          "name" : "methodRequestQueryParam",
          "in" : "query",
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "methodRequestHeaderParam",
          "in" : "header",
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "200 response"
          }
        },
        "x-amazon-apigateway-integration" : {
          "httpMethod" : "GET",
          "uri" : "http://petstore-demo-endpoint.execute-api.com/petstore/pets",
          "responses" : {
            "default" : {
              "statusCode" : "200"
            }
          },
          "requestParameters" : {
            "integration.request.querystring.integrationQueryParam" : "method.request.multivaluequerystring.methodRequestQueryParam",
            "integration.request.path.integrationPathParam" : "method.request.header.methodRequestHeaderParam"
          },
          "requestTemplates" : {
            "application/json" : "{\"statusCode\": 200}"
          },
          "passthroughBehavior" : "when_no_templates",
          "timeoutInMillis" : 29000,
          "type" : "http"
        }
      }
    }
  }
}

anchor anchor anchor

Um die Anforderungsparameter der Methode zuzuordnen

Melden Sie sich bei der API Gateway Gateway-Konsole unter https://console.aws.amazon.com/apigatewayan.
Wählen Sie eine REST-API aus.
Wählen Sie eine Methode.

Ihre Methode muss über eine Nicht-Proxy-Integration verfügen.
Wählen Sie für Einstellungen für Methodenanfragen die Option Bearbeiten aus.
Klicken Sie auf Parameter für URL-Abfragezeichenfolgen.
Wählen Sie Abfragezeichenfolge hinzufügen aus.
Geben Sie unter Name methodRequestQueryParam ein.
Wählen Sie HTTP-Anforderungs-Headers aus.
Wählen Sie Add header.
Geben Sie unter Name methodRequestHeaderParam ein.
Wählen Sie Save (Speichern) aus.
Wählen Sie die Registerkarte Integrationsanfrage aus und klicken Sie dann unter Einstellungen für Integrationsanforderungen auf Bearbeiten.
Klicken Sie auf URL-Pfadparameter.
Klicken Sie auf Pfadparameter hinzufügen.
Geben Sie unter Name integrationPathParam ein.
Geben Sie für Zugeordnet von method.request.header.methodRequestHeaderParam ein.

Dadurch wird der Methodenanforderungsheader, den Sie in der Methodenanforderung angegeben haben, einem neuen Pfadparameter für die Integrationsanforderung zugeordnet.
Klicken Sie auf Parameter für URL-Abfragezeichenfolgen.
Wählen Sie Abfragezeichenfolge hinzufügen aus.
Geben Sie unter Name integrationQueryParam ein.
Geben Sie für Zugeordnet von method.request.multivaluequerystring.methodRequestQueryParam ein.

Dadurch wird der mehrwertige Abfragezeichenfolgenparameter einem neuen einwertigen Abfragezeichenfolgenparameter für die Integrationsanforderung zugeordnet.
Wählen Sie Save (Speichern) aus.
Sie müssen Ihre API erneut bereitstellen, damit die Änderungen wirksam werden.

Beispiel 3: Ordnen Sie Felder aus dem Hauptteil der JSON-Anforderung den Parametern der Integrationsanfrage zu

Sie können Integrationsanforderungsparameter auch Feldern im JSON-Anfragetext mithilfe eines JSONPath Ausdrucks zuordnen. Das folgende Beispiel ordnet den Hauptteil der Methodenanfrage einem Header der Integrationsanfrage mit dem Namen zu body-header und ordnet einen Teil des Anforderungstexts, wie er in einem JSON-Ausdruck ausgedrückt wird, einem Header der Integrationsanfrage mit dem Namen zupet-price.

Um dieses Beispiel zu testen, geben Sie eine Eingabe ein, die eine Preiskategorie enthält, z. B. die folgende:


[ 
  { 
    "id": 1, 
    "type": "dog", 
    "price": 249.99 
  }
]

AWS Management Console

Um die Anforderungsparameter der Methode zuzuordnen

Melden Sie sich bei der API Gateway Gateway-Konsole unter https://console.aws.amazon.com/apigatewayan.
Wählen Sie eine REST-API aus.
Wählen Sie einePOST, PUTPATCH, oder Methode. ANY

Ihre Methode muss über eine Nicht-Proxy-Integration verfügen.
Wählen Sie für Einstellungen für Integrationsanfragen die Option Bearbeiten aus.
Wählen Sie die Parameter für URL-Anforderungsheader aus.
Wählen Sie Anforderungsheader-Parameter hinzufügen.
Geben Sie unter Name body-header ein.
Geben Sie für Zugeordnet von method.request.body ein.

Dadurch wird der Hauptteil der Methodenanfrage einem neuen Header-Parameter der Integrationsanfrage zugeordnet.
Wählen Sie Anforderungs-Header-Parameter hinzufügen aus.
Geben Sie unter Name pet-price ein.
Geben Sie für Zugeordnet von method.request.body[0].price ein.

Dadurch wird ein Teil des Hauptteils der Methodenanfrage einem neuen Header-Parameter der Integrationsanfrage zugeordnet.
Wählen Sie Save (Speichern) aus.
Sie müssen Ihre API erneut bereitstellen, damit die Änderungen wirksam werden.

AWS CloudFormation

In diesem Beispiel verwenden Sie die Eigenschaft body, um eine OpenAPI-Definitionsdatei in API Gateway zu importieren.


AWSTemplateFormatVersion: 2010-09-09
Resources:
  Api:
    Type: 'AWS::ApiGateway::RestApi'
    Properties:
      Body: 
        openapi: 3.0.1
        info:
          title: Parameter mapping example 3
          version: "2025-01-15T19:19:14Z"
        paths:
          /:
            post:
              responses:
                "200":
                  description: 200 response
              x-amazon-apigateway-integration:
                httpMethod: GET
                uri: http://petstore-demo-endpoint.execute-api.com/petstore/pets
                responses:
                  default:
                    statusCode: "200"
                requestParameters:
                  integration.request.header.pet-price: method.request.body[0].price
                  integration.request.header.body-header: method.request.body
                requestTemplates:
                  application/json: '{"statusCode": 200}'
                passthroughBehavior: when_no_templates
                timeoutInMillis: 29000
                type: http
  ApiGatewayDeployment:
    Type: 'AWS::ApiGateway::Deployment'
    DependsOn: Api 
    Properties: 
      RestApiId: !Ref Api
  ApiGatewayDeployment20250219:
    Type: 'AWS::ApiGateway::Deployment'
    DependsOn: Api 
    Properties: 
      RestApiId: !Ref Api
  Stage:
    Type: 'AWS::ApiGateway::Stage'
    Properties:
       DeploymentId: !Ref ApiGatewayDeployment20250219
       RestApiId: !Ref Api
       StageName: prod

OpenAPI

Die folgende OpenAPI-Definition ordnet Integrationsanforderungsparameter Feldern im JSON-Anforderungstext zu.


{
  "openapi" : "3.0.1",
  "info" : {
    "title" : "Parameter mapping example 3",
    "version" : "2025-01-15T19:19:14Z"
  },
  "paths" : {
    "/" : {
      "post" : {
        "responses" : {
          "200" : {
            "description" : "200 response"
          }
        },
        "x-amazon-apigateway-integration" : {
          "httpMethod" : "GET",
          "uri" : "http://petstore-demo-endpoint.execute-api.com/petstore/pets",
          "responses" : {
            "default" : {
              "statusCode" : "200"
            }
          },
          "requestParameters" : {
            "integration.request.header.pet-price" : "method.request.body[0].price",
            "integration.request.header.body-header" : "method.request.body"
          },
          "requestTemplates" : {
            "application/json" : "{\"statusCode\": 200}"
          },
          "passthroughBehavior" : "when_no_templates",
          "timeoutInMillis" : 29000,
          "type" : "http"
        }
      }
    }
  }
}

anchor anchor anchor

Um die Anforderungsparameter der Methode zuzuordnen

Melden Sie sich bei der API Gateway Gateway-Konsole unter https://console.aws.amazon.com/apigatewayan.
Wählen Sie eine REST-API aus.
Wählen Sie einePOST, PUTPATCH, oder Methode. ANY

Ihre Methode muss über eine Nicht-Proxy-Integration verfügen.
Wählen Sie für Einstellungen für Integrationsanfragen die Option Bearbeiten aus.
Wählen Sie die Parameter für URL-Anforderungsheader aus.
Wählen Sie Anforderungsheader-Parameter hinzufügen.
Geben Sie unter Name body-header ein.
Geben Sie für Zugeordnet von method.request.body ein.

Dadurch wird der Hauptteil der Methodenanfrage einem neuen Header-Parameter der Integrationsanfrage zugeordnet.
Wählen Sie Anforderungs-Header-Parameter hinzufügen aus.
Geben Sie unter Name pet-price ein.
Geben Sie für Zugeordnet von method.request.body[0].price ein.

Dadurch wird ein Teil des Hauptteils der Methodenanfrage einem neuen Header-Parameter der Integrationsanfrage zugeordnet.
Wählen Sie Save (Speichern) aus.
Sie müssen Ihre API erneut bereitstellen, damit die Änderungen wirksam werden.

Beispiel 4: Ordnen Sie die Integrationsantwort der Methodenantwort zu

Sie können die Integrationsantwort auch der Methodenantwort zuordnen. Im folgenden Beispiel wird der Hauptteil der Integrationsantwort einem Methodenantwort-Header mit dem Namenlocation, der Header x-app-id der Integrationsantwort dem Methodenantwort-Header id und der mehrwertige Integrationsantwort-Header item dem Methodenantwort-Header items zugeordnet.

AWS Management Console

Um die Integrationsantwort zuzuordnen

Melden Sie sich bei der API Gateway Gateway-Konsole unter https://console.aws.amazon.com/apigatewayan.
Wählen Sie eine REST-API aus.
Wählen Sie eine Methode.

Ihre Methode muss über eine Nicht-Proxy-Integration verfügen.
Wählen Sie die Registerkarte Methodenantwort und dann für Antwort 200 die Option Bearbeiten aus.
Wählen Sie als Header-Name die Option Header hinzufügen aus.
Erstellen Sie drei Header mit den Namen iditem, undlocation.
Wählen Sie Save (Speichern) aus.
Wählen Sie die Registerkarte Integrationsantwort und wählen Sie dann für Standard — Antwort die Option Bearbeiten aus.
Geben Sie unter Header-Zuordnungen Folgendes ein.
1. Geben Sie für ID Folgendes ein integration.response.header.x-app-id
2. Geben Sie für den Artikel Folgendes ein integration.response.multivalueheader.item
3. Geben Sie für den Standort Folgendes ein integration.response.body.redirect.url
Wählen Sie Save (Speichern) aus.
Sie müssen Ihre API erneut bereitstellen, damit die Änderungen wirksam werden.

AWS CloudFormation

In diesem Beispiel verwenden Sie die Eigenschaft body, um eine OpenAPI-Definitionsdatei in API Gateway zu importieren.


AWSTemplateFormatVersion: 2010-09-09
Resources:
  Api:
    Type: 'AWS::ApiGateway::RestApi'
    Properties:
      Body:
        openapi: 3.0.1
        info:
          title: Parameter mapping example
          version: "2025-01-15T19:21:35Z"
        paths:
          /:
            post:
              responses:
                "200":
                  description: 200 response
                  headers:
                    item:
                      schema:
                        type: string
                    location:
                      schema:
                        type: string
                    id:
                      schema:
                        type: string
              x-amazon-apigateway-integration:
                type: http
                httpMethod: GET
                uri: http://petstore-demo-endpoint.execute-api.com/petstore/pets
                responses:
                  default:
                    statusCode: "200"
                    responseParameters:
                      method.response.header.id: integration.response.header.x-app-id
                      method.response.header.location: integration.response.body.redirect.url
                      method.response.header.item: integration.response.multivalueheader.item
                requestTemplates:
                  application/json: '{"statusCode": 200}'
                passthroughBehavior: when_no_templates
                timeoutInMillis: 29000
  ApiGatewayDeployment:
    Type: 'AWS::ApiGateway::Deployment'
    DependsOn: Api 
    Properties: 
      RestApiId: !Ref Api
  ApiGatewayDeployment20250219:
    Type: 'AWS::ApiGateway::Deployment'
    DependsOn: Api 
    Properties: 
      RestApiId: !Ref Api
  Stage:
    Type: 'AWS::ApiGateway::Stage'
    Properties:
       DeploymentId: !Ref ApiGatewayDeployment20250219
       RestApiId: !Ref Api
       StageName: prod

OpenAPI

Die folgende OpenAPI-Definition ordnet die Integrationsantwort der Methodenantwort zu.


{
  "openapi" : "3.0.1",
  "info" : {
    "title" : "Parameter mapping example",
    "version" : "2025-01-15T19:21:35Z"
  },
  "paths" : {
    "/" : {
      "post" : {
        "responses" : {
          "200" : {
            "description" : "200 response",
            "headers" : {
              "item" : {
                "schema" : {
                  "type" : "string"
                }
              },
              "location" : {
                "schema" : {
                  "type" : "string"
                }
              },
              "id" : {
                "schema" : {
                  "type" : "string"
                }
              }
            }
          }
        },
        "x-amazon-apigateway-integration" : {
          "type" : "http",
          "httpMethod" : "GET",
          "uri" : "http://petstore-demo-endpoint.execute-api.com/petstore/pets",
          "responses" : {
            "default" : {
              "statusCode" : "200",
              "responseParameters" : {
                "method.response.header.id" : "integration.response.header.x-app-id",
                "method.response.header.location" : "integration.response.body.redirect.url",
                "method.response.header.item" : "integration.response.multivalueheader.item"
              }
            }
          },
          "requestTemplates" : {
            "application/json" : "{\"statusCode\": 200}"
          },
          "passthroughBehavior" : "when_no_templates",
          "timeoutInMillis" : 29000
        }
      }
    }
  }
}

anchor anchor anchor

Um die Integrationsantwort zuzuordnen

Melden Sie sich bei der API Gateway Gateway-Konsole unter https://console.aws.amazon.com/apigatewayan.
Wählen Sie eine REST-API aus.
Wählen Sie eine Methode.

Ihre Methode muss über eine Nicht-Proxy-Integration verfügen.
Wählen Sie die Registerkarte Methodenantwort und dann für Antwort 200 die Option Bearbeiten aus.
Wählen Sie als Header-Name die Option Header hinzufügen aus.
Erstellen Sie drei Header mit den Namen iditem, undlocation.
Wählen Sie Save (Speichern) aus.
Wählen Sie die Registerkarte Integrationsantwort und wählen Sie dann für Standard — Antwort die Option Bearbeiten aus.
Geben Sie unter Header-Zuordnungen Folgendes ein.
1. Geben Sie für ID Folgendes ein integration.response.header.x-app-id
2. Geben Sie für den Artikel Folgendes ein integration.response.multivalueheader.item
3. Geben Sie für den Standort Folgendes ein integration.response.body.redirect.url
Wählen Sie Save (Speichern) aus.
Sie müssen Ihre API erneut bereitstellen, damit die Änderungen wirksam werden.

Warnung JavaScript ist in Ihrem Browser nicht verfügbar oder deaktiviert.

Zur Nutzung der AWS-Dokumentation muss JavaScript aktiviert sein. Weitere Informationen finden auf den Hilfe-Seiten Ihres Browsers.

Dokumentkonventionen

Parameter-Mapping

Quellenreferenz für die Parameterzuordnung

Auf dieser Seite

Wählen Sie Ihre Cookie-Einstellungen aus

Cookie-Einstellungen anpassen

Essenziell

Leistung

Funktional

Werbung

Cookie-Einstellungen konnten nicht gespeichert werden

Beispiele für die Parameterzuweisung für REST APIs in API Gateway

Beispiel 1: Ordnen Sie einen Methodenanforderungsparameter einem Integrationsanforderungsparameter zu

Um den Methodenanforderungsparameter zuzuordnen

(Optional) Testen Sie Ihre Parameterzuordnung

Um den Methodenanforderungsparameter zuzuordnen

(Optional) Testen Sie Ihre Parameterzuordnung

Beispiel 2: Ordnen Sie mehrere Methodenanforderungsparameter verschiedenen Integrationsanforderungsparametern zu

Um die Anforderungsparameter der Methode zuzuordnen

Um die Anforderungsparameter der Methode zuzuordnen

Beispiel 3: Ordnen Sie Felder aus dem Hauptteil der JSON-Anforderung den Parametern der Integrationsanfrage zu

Um die Anforderungsparameter der Methode zuzuordnen

Um die Anforderungsparameter der Methode zuzuordnen

Beispiel 4: Ordnen Sie die Integrationsantwort der Methodenantwort zu

Um die Integrationsantwort zuzuordnen

Um die Integrationsantwort zuzuordnen

Auf dieser Seite

Related resources

Hat Ihnen diese Seite geholfen?

Related resources

Nächstes Thema:

Vorheriges Thema:

Brauchen Sie Hilfe?