Configurazione delle trasformazioni dei dati in Gateway Amazon API

Questa sezione mostra come configurare modelli di mappatura per trasformare le richieste e le risposte di integrazione utilizzando la console e la AWS CLI.

Configurare la trasformazione dei dati utilizzando la console Gateway Amazon API

In questo tutorial, creerai un'API incompleta e una tabella DynamoDB utilizzando il seguente file.zip .zip. data-transformation-tutorial-console Questa API incompleta dispone di una risorsa /pets  con i metodi GET e POST.

• Il metodo GET otterrà i dati dall'endpoint HTTP http://petstore-demo-endpoint.execute-api.com/petstore/pets. I dati di output verranno trasformati in base al modello di mappatura in PetStore modello di mappatura.

• Il metodo POST consentirà all'utente di pubblicare (POST) le informazioni sugli animali domestici in una tabella Amazon DynamoDB utilizzando un modello di mappatura.

Scarica e decomprimi il modello di creazione dell'app per. AWS CloudFormation Verrà utilizzato questo modello per creare una tabella DynamoDB per pubblicare informazioni sugli animali domestici e un'API incompleta. Il resto della procedura verrà completato nella console Gateway Amazon API.

Per creare una pila AWS CloudFormation

1. Apri la AWS CloudFormation console all'indirizzo https://console.aws.amazon.com/cloudformation.

2. Scegliere Create stack (Crea stack), quindi With new resources (standard) (Con nuove risorse (standard)).

3. In Specificare modello, scegliere Carica un file modello.

4. Selezionare il modello scaricato.

5. Seleziona Successivo.

6. Per Stack name (Nome stack), inserire data-transformation-tutorial-console, quindi scegliere Next (Avanti).

7. Per Configure stack options (Configura opzioni di stack), scegliere Next (Successivo).

8. Per quanto riguarda le funzionalità, riconosci che AWS CloudFormation puoi creare risorse IAM nel tuo account.

9. Scegli Invia.

AWS CloudFormation fornisce le risorse specificate nel modello. Per completare il provisioning delle risorse, potrebbero essere necessari alcuni minuti. Quando lo stato del tuo AWS CloudFormation stack è CREATE_COMPLETE, sei pronto per passare alla fase successiva.

Test della risposta di integrazione GET

1. Nella scheda Risorse dello AWS CloudFormation stack didata-transformation-tutorial-console, seleziona l'ID fisico della tua API.

2. Nel pannello di navigazione principale scegli Risorse, quindi seleziona il metodo GET.

3. Seleziona la scheda Test. Potrebbe essere necessario scegliere il pulsante freccia destra per visualizzare la scheda.

   L'output del test mostrerà quanto segue:

   [
     {
       "id": 1,
       "type": "dog",
       "price": 249.99
     },
     {
       "id": 2,
       "type": "cat",
       "price": 124.99
     },
     {
       "id": 3,
       "type": "fish",
       "price": 0.99
     }
   ]

   Questo output verrà trasformato in base al modello di mappatura in PetStore modello di mappatura.

Trasformazione della risposta di integrazione GET

1. Scegli la scheda Risposta di integrazione.

   Attualmente non sono definiti modelli di mappatura, quindi la risposta di integrazione non verrà trasformata.

2. Per Predefinito - Risposta scegli Modifica.

3. Scegli Modelli di mappatura e procedi come indicato di seguito:

   1. Scegliere Add mapping template (Aggiungi modello di mappatura).

   2. Per Tipo di contenuto inserisci application/json.

   3. Per Corpo del modello inserisci quanto segue:

      #set($inputRoot = $input.path('$'))
      [
      #foreach($elem in $inputRoot)
        {
          "description" : "Item $elem.id is a $elem.type.",
          "askingPrice" : $elem.price
        }#if($foreach.hasNext),#end
      
      #end
      ]

   Selezionare Salva.

Test della risposta di integrazione GET

• Scegli la scheda Test, quindi seleziona Test.

  L'output del test mostrerà la risposta trasformata.

  [
    {
      "description" : "Item 1 is a dog.",
      "askingPrice" : 249.99
    },
    {
      "description" : "Item 2 is a cat.",
      "askingPrice" : 124.99
    },
    {
      "description" : "Item 3 is a fish.",
      "askingPrice" : 0.99
    }
  ]

Trasformazione dei dati di input dal metodo POST

1. Scegli il metodo POST.

2. Scegli la scheda Richiesta di integrazione, quindi seleziona Modifica per Impostazioni della richiesta di integrazione.

   Il AWS CloudFormation modello ha compilato alcuni campi di richiesta di integrazione.

   • Il tipo di integrazione è Servizio AWS.

   • Servizio AWS Si tratta di DynamoDB.

   • Il metodo HTTP è POST.

   • L'operazione è PutItem.

   • Il ruolo di esecuzione che consente ad API Gateway di inserire un elemento nella tabella DynamoDB è. data-transformation-tutorial-console-APIGatewayRole AWS CloudFormation ha creato questo ruolo per consentire ad API Gateway di disporre delle autorizzazioni minime per interagire con DynamoDB.

   Il nome della tabella DynamoDB non è stato specificato. Il nome verrà specificato nei passaggi seguenti.

3. Per Richiesta corpo passthrough seleziona Mai.

   Ciò significa che l'API rifiuterà i dati con Content-Types che non dispongono di un modello di mappatura.

4. Scegli Modelli di mappatura.

5. Tipo di contenuto è impostato su application/json. Ciò significa che i tipi di contenuto diversi da application/json verranno rifiutati dall'API. Per ulteriori informazioni sui comportamenti passthrough di integrazione, consultare Comportamenti passthrough di integrazione.

6. Inserire il codice seguente nell'editor di testo.

   {
       "TableName":"data-transformation-tutorial-console-ddb",
       "Item": {
           "id": {
               "N": $input.json("$.id")
           },
           "type": {
               "S": $input.json("$.type")
           },
           "price": {
               "N": $input.json("$.price")
           }
       }
   }

   Questo modello specifica la tabella come data-transformation-tutorial-console-ddb e imposta gli elementi come id, type eprice. Gli elementi proverranno dal corpo del metodo POST. È anche possibile utilizzare un modello di dati per creare un modello di mappatura. Per ulteriori informazioni, consulta Utilizzo della convalida delle richieste in Gateway Amazon API.

7. Scegliere il pulsante Salva per salvare il modello di mappatura.

Aggiunta di un metodo e una risposta di integrazione dal metodo POST

Hanno AWS CloudFormation creato un metodo e una risposta di integrazione vuoti. Questa risposta verrà modificata per fornire ulteriori informazioni. Per ulteriori informazioni su come modificare le risposte, consultare Riferimento alla mappatura dei dati di richiesta e di risposta delle API di Amazon API Gateway.

1. Nella scheda Risposta di integrazione scegli Modifica per Predefinito - Risposta.

2. Scegli Modelli di mappatura, quindi seleziona Aggiungi modello di mappatura.

3. Per Content-type immetti application/json.

4. Nell'editor di codice, inserire il seguente modello di mappatura di output per inviare un messaggio di output:

   { "message" : "Your response was recorded at $context.requestTime" }

   Per ulteriori informazioni sulle variabili di contesto, consultare $contextVariabili per modelli di dati, autorizzatori, modelli di mappatura e registrazione degli accessi CloudWatch .

5. Scegliere il pulsante Salva per salvare il modello di mappatura.

Test del metodo POST

Seleziona la scheda Test. Potrebbe essere necessario scegliere il pulsante freccia destra per visualizzare la scheda.

1. Nel corpo della richiesta, inserire il seguente esempio.

   {
             "id": "4",
             "type" : "dog",
             "price": "321"
   }

2. Scegli Test (Esegui test).

   L'output dovrebbe mostrare il messaggio di operazione riuscita.

   È possibile aprire la console DynamoDB all'indirizzo https://console.aws.amazon.com/dynamodb/ per verificare che l'elemento di esempio sia nella tabella.

Per eliminare una AWS CloudFormation pila

1. Apri la AWS CloudFormation console all'indirizzo https://console.aws.amazon.com/cloudformation.

2. Seleziona il tuo AWS CloudFormation stack.

3. Scegli Elimina e conferma la tua scelta.

Configura la trasformazione dei dati utilizzando la AWS CLI

In questo tutorial, creerai un'API incompleta e una tabella DynamoDB utilizzando il seguente file.zip .zip. data-transformation-tutorial-cli Questa API incompleta dispone di una risorsa /pets con un metodo GET integrato con l'endpoint HTTP http://petstore-demo-endpoint.execute-api.com/petstore/pets. Verrà creato un metodo POST per connettersi a una tabella DynamoDB e si useranno modelli di mappatura per inserire dati in una tabella DynamoDB.

• I dati di output verranno quindi trasformati in base al modello di mappatura in PetStore modello di mappatura.

• Verrà creato un metodo POST per consentire all'utente di pubblicare (POST) le informazioni sugli animali domestici in una tabella Amazon DynamoDB utilizzando un modello di mappatura.

Per creare uno stack AWS CloudFormation

Scarica e decomprimi il modello di creazione dell'app per. AWS CloudFormation

Per completare il tutorial seguente, è necessario disporre della AWS Command Line Interface (AWS CLI) versione 2.

Per i comandi lunghi viene utilizzato un carattere di escape (\) per dividere un comando su più righe.

Nota

In Windows, alcuni comandi della CLI Bash utilizzati comunemente (ad esempio, zip) non sono supportati dai terminali integrati del sistema operativo. Per ottenere una versione integrata su Windows di Ubuntu e Bash, installa il sottosistema Windows per Linux. I comandi della CLI di esempio in questa guida utilizzano la formattazione Linux. Se si utilizza la CLI di Windows, i comandi che includono documenti JSON in linea dovranno essere riformattati.

1. Usa il seguente comando per creare lo AWS CloudFormation stack.

   aws cloudformation create-stack --stack-name data-transformation-tutorial-cli --template-body file://data-transformation-tutorial-cli.zip --capabilities CAPABILITY_NAMED_IAM 

2. AWS CloudFormation fornisce le risorse specificate nel modello. Per completare il provisioning delle risorse, potrebbero essere necessari alcuni minuti. Usa il comando seguente per vedere lo stato del tuo AWS CloudFormation stack.

   aws cloudformation describe-stacks --stack-name data-transformation-tutorial-cli

3. Quando lo stato dello AWS CloudFormation stack èStackStatus: "CREATE_COMPLETE", usa il seguente comando per recuperare i valori di output pertinenti per i passaggi futuri.

    aws cloudformation describe-stacks --stack-name data-transformation-tutorial-cli --query "Stacks[*].Outputs[*].{OutputKey: OutputKey, OutputValue: OutputValue, Description: Description}"

   Di seguito sono riportati i valori di output:

   • ApiRole, che è il nome del ruolo che consente ad API Gateway di inserire elementi nella tabella DynamoDB. Per questo tutorial, il nome del ruolo è data-transformation-tutorial-cli-APIGatewayRole-ABCDEFG.

   • DDBTableName, che è il nome della tabella DynamoDB. Per questo tutorial il nome della tabella è data-transformation-tutorial-cli-ddb.

   • ResourceId, che è l'ID della risorsa pets in cui sono esposti i POST metodi GET and. Per questo tutorial, l'ID risorsa è efg456.

   • ApiId, che è l'ID dell'API. Per questo tutorial, l'ID API è abc123.

Test del metodo GET prima della trasformazione dei dati

• Utilizzare il seguente comando per eseguire il test del metodo GET.

  aws apigateway test-invoke-method --rest-api-id abc123 \
            --resource-id efg456 \
            --http-method GET

  L'output del test riporterà le seguenti informazioni.

  [
    {
      "id": 1,
      "type": "dog",
      "price": 249.99
    },
    {
      "id": 2,
      "type": "cat",
      "price": 124.99
    },
    {
      "id": 3,
      "type": "fish",
      "price": 0.99
    }
  ]

  Questo output verrà trasformato in base al modello di mappatura in PetStore modello di mappatura.

Trasformazione della risposta di integrazione GET

• Utilizzare il comando seguente per aggiornare una risposta di integrazione per il metodo GET. Sostituisci rest-api-idand resource-id con i tuoi valori.

  Per creare una risposta di integrazione, utilizzare il comando seguente.

  aws apigateway put-integration-response --rest-api-id abc123 \
    --resource-id efg456 \
    --http-method GET \
    --status-code 200 \
    --selection-pattern "" \
    --response-templates '{"application/json": "#set($inputRoot = $input.path(\"$\"))\n[\n#foreach($elem in $inputRoot)\n {\n  \"description\": \"Item $elem.id is a $elem.type\",\n  \"askingPrice\": \"$elem.price\"\n }#if($foreach.hasNext),#end\n\n#end\n]"}'

Test del metodo GET

• Utilizzare il seguente comando per eseguire il test del metodo GET.

  aws apigateway test-invoke-method --rest-api-id abc123 \
    --resource-id efg456 \
    --http-method GET \
  

  L'output del test mostrerà la risposta trasformata.

  [
    {
      "description" : "Item 1 is a dog.",
      "askingPrice" : 249.99
    },
    {
      "description" : "Item 2 is a cat.",
      "askingPrice" : 124.99
    },
    {
      "description" : "Item 3 is a fish.",
      "askingPrice" : 0.99
    }
  ]

Creazione di un metodo POST

1. Utilizzare il seguente comando per creare un nuovo metodo nella risorsa /pets.

   aws apigateway put-method --rest-api-id abc123 \
     --resource-id efg456 \
     --http-method POST \
     --authorization-type "NONE" \
   

   Questo metodo ti consentirà di inviare informazioni sugli animali domestici alla tabella DynamoDB che hai creato nello stack. AWS CloudFormation

2. Utilizzate il seguente comando per creare un' Servizio AWS integrazione sul metodo. POST

   aws apigateway put-integration --rest-api-id abc123 \
     --resource-id efg456 \
     --http-method POST \
     --type AWS \
     --integration-http-method POST \
     --uri "arn:aws:apigateway:us-east-2:dynamodb:action/PutItem" \
     --credentials arn:aws:iam::111122223333:role/data-transformation-tutorial-cli-APIGatewayRole-ABCDEFG \
     --request-templates '{"application/json":"{\"TableName\":\"data-transformation-tutorial-cli-ddb\",\"Item\":{\"id\":{\"N\":$input.json(\"$.id\")},\"type\":{\"S\":$input.json(\"$.type\")},\"price\":{\"N\":$input.json(\"$.price\")} }}"}'
   

3. Utilizzare il comando seguente per creare una risposta del metodo per una corretta chiamata del metodo POST.

   aws apigateway put-method-response --rest-api-id abc123 \
     --resource-id efg456 \
     --http-method POST \
     --status-code 200

4. Utilizzare il comando seguente per creare una risposta dell'integrazione per una corretta chiamata del metodo POST.

   aws apigateway put-integration-response --rest-api-id abc123 \
     --resource-id efg456 \
     --http-method POST \
     --status-code 200 \
     --selection-pattern "" \
     --response-templates '{"application/json": "{\"message\": \"Your response was recorded at $context.requestTime\"}"}'

Test del metodo POST

• Utilizzare il seguente comando per eseguire il test del metodo POST.

  aws apigateway test-invoke-method --rest-api-id abc123 \
    --resource-id efg456 \
    --http-method POST \
    --body '{\"id\": \"4\", \"type\": \"dog\", \"price\": \"321\"}'

  L'output mostrerà il messaggio di operazione riuscita.

Per eliminare una AWS CloudFormation pila

• Usa il seguente comando per eliminare le tue AWS CloudFormation risorse.

  aws cloudformation delete-stack  --stack-name data-transformation-tutorial-cli

AWS CloudFormation Modello di trasformazione dei dati completato

L'esempio seguente è un AWS CloudFormation modello completo, che crea un'API e una tabella DynamoDB con /pets una risorsa GET con metodi and. POST

• Il metodo GET recupererà i dati dall'endpoint HTTP http://petstore-demo-endpoint.execute-api.com/petstore/pets. I dati di output verranno trasformati in base al modello di mappatura in PetStore modello di mappatura.

• Il metodo POST consentirà all'utente di pubblicare (POST) le informazioni sugli animali domestici in una tabella DynamoDB utilizzando un modello di mappatura.

AWSTemplateFormatVersion: 2010-09-09
Description: A completed Amazon API Gateway REST API that uses non-proxy integration to POST to an Amazon DynamoDB table and non-proxy integration to GET transformed pets data.
Parameters:
  StageName:
    Type: String
    Default: v1
    Description: Name of API stage.
Resources:
  DynamoDBTable:
    Type: 'AWS::DynamoDB::Table'
    Properties:
      TableName: !Sub data-transformation-tutorial-complete
      AttributeDefinitions:
        - AttributeName: id
          AttributeType: N
      KeySchema:
        - AttributeName: id
          KeyType: HASH
      ProvisionedThroughput:
        ReadCapacityUnits: 5
        WriteCapacityUnits: 5
  APIGatewayRole:
    Type: 'AWS::IAM::Role'
    Properties:
      AssumeRolePolicyDocument:
        Version: 2012-10-17
        Statement:
          - Action:
              - 'sts:AssumeRole'
            Effect: Allow
            Principal:
              Service:
                - apigateway.amazonaws.com
      Policies:
        - PolicyName: APIGatewayDynamoDBPolicy
          PolicyDocument:
            Version: 2012-10-17
            Statement:
              - Effect: Allow
                Action:
                  - 'dynamodb:PutItem'
                Resource: !GetAtt DynamoDBTable.Arn
  Api:
    Type: 'AWS::ApiGateway::RestApi'
    Properties:
      Name: data-transformation-complete-api
      ApiKeySourceType: HEADER
  PetsResource:
    Type: 'AWS::ApiGateway::Resource'
    Properties:
      RestApiId: !Ref Api
      ParentId: !GetAtt Api.RootResourceId
      PathPart: 'pets'
  PetsMethodGet:
    Type: 'AWS::ApiGateway::Method'
    Properties:
      RestApiId: !Ref Api
      ResourceId: !Ref PetsResource
      HttpMethod: GET
      ApiKeyRequired: false
      AuthorizationType: NONE
      Integration:
        Type: HTTP
        Credentials: !GetAtt APIGatewayRole.Arn
        IntegrationHttpMethod: GET
        Uri: http://petstore-demo-endpoint.execute-api.com/petstore/pets/
        PassthroughBehavior: WHEN_NO_TEMPLATES
        IntegrationResponses:
          - StatusCode: '200'
            ResponseTemplates:
              application/json: "#set($inputRoot = $input.path(\"$\"))\n[\n#foreach($elem in $inputRoot)\n {\n  \"description\": \"Item $elem.id is a $elem.type\",\n  \"askingPrice\": \"$elem.price\"\n }#if($foreach.hasNext),#end\n\n#end\n]"
      MethodResponses:
        - StatusCode: '200'
  PetsMethodPost:
    Type: 'AWS::ApiGateway::Method'
    Properties:
      RestApiId: !Ref Api
      ResourceId: !Ref PetsResource
      HttpMethod: POST
      ApiKeyRequired: false
      AuthorizationType: NONE
      Integration:
        Type: AWS
        Credentials: !GetAtt APIGatewayRole.Arn
        IntegrationHttpMethod: POST
        Uri: arn:aws:apigateway:us-west-1:dynamodb:action/PutItem
        PassthroughBehavior: NEVER
        RequestTemplates: 
          application/json: "{\"TableName\":\"data-transformation-tutorial-complete\",\"Item\":{\"id\":{\"N\":$input.json(\"$.id\")},\"type\":{\"S\":$input.json(\"$.type\")},\"price\":{\"N\":$input.json(\"$.price\")} }}"
        IntegrationResponses:
          - StatusCode: 200
            ResponseTemplates:
              application/json: "{\"message\": \"Your response was recorded at $context.requestTime\"}"
      MethodResponses:
        - StatusCode: '200'

  ApiDeployment:
    Type: 'AWS::ApiGateway::Deployment'
    DependsOn:
      - PetsMethodGet
    Properties:
      RestApiId: !Ref Api
      StageName: !Sub '${StageName}'
Outputs:
  ApiId:
    Description: API ID for CLI commands
    Value: !Ref Api
  ResourceId:
    Description: /pets resource ID for CLI commands
    Value: !Ref PetsResource
  ApiRole:
    Description: Role ID to allow API Gateway to put and scan items in DynamoDB table
    Value: !Ref APIGatewayRole
  DDBTableName:
    Description: DynamoDB table name
    Value: !Ref DynamoDBTable

Passaggi successivi

Per esplorare modelli di mappatura più complessi, fai riferimento ai seguenti modelli:

• Visualizzare modelli e modelli di mappatura più complessi con l'album fotografico di esempio Esempio di album fotografico.

• Per ulteriori informazioni sui modelli , consulta Informazioni sui modelli di dati.

• Per informazioni su come mappare i diversi output del codice di risposta, Configurazione delle mappature dei dati di richiesta e di risposta tramite la console API Gateway.

• Per informazioni su come impostare le mappature dei dati dai dati di richiesta del metodo di un'API, Informazioni di riferimento sui modelli di mappatura e sulle variabili di logging degli accessi in API Gateway.