Integra Amazon API Gateway con Amazon SQS per gestire REST asincrono APIs - Prontuario AWS
RiepilogoPrerequisiti e limitazioniArchitetturaStrumentiEpicheRisorse correlate

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Integra Amazon API Gateway con Amazon SQS per gestire REST asincrono APIs

Creato da Natalia Colantonio Favero (AWS) e Gustavo Martim (AWS)

Riepilogo

Quando si distribuisce REST APIs, a volte è necessario esporre una coda di messaggi che le applicazioni client possono pubblicare. Ad esempio, potreste avere problemi con la latenza di terze parti APIs e i ritardi nelle risposte, oppure potreste voler evitare i tempi di risposta delle query del database o evitare il ridimensionamento del server quando il numero di richieste simultanee è elevato. APIs In questi scenari, le applicazioni client che pubblicano nella coda devono solo sapere che l'API ha ricevuto i dati, non cosa accade dopo la ricezione dei dati.

Questo modello crea un endpoint API REST utilizzando Amazon API Gateway per inviare un messaggio ad Amazon Simple Queue Service (Amazon SQS). Crea un' easy-to-implementintegrazione tra i due servizi che evita l'accesso diretto alla coda SQS.

Prerequisiti e limitazioni

Architettura

Architettura per l'integrazione di API Gateway con Amazon SQS

Il diagramma illustra questi passaggi:

  1. Richiedi un endpoint dell'API POST REST utilizzando uno strumento come Postman, un'altra API o altre tecnologie.

  2. API Gateway pubblica un messaggio, che viene ricevuto nel corpo della richiesta, sulla coda.

  3. Amazon SQS riceve il messaggio e invia una risposta ad API Gateway con un codice di successo o di errore.

Strumenti

Epiche

AttivitàDescrizioneCompetenze richieste

Crea una coda.

Per creare una coda SQS che riceva i messaggi dall'API REST:

  1. Accedi al tuo Account AWS.

  2. Apri la console Amazon SQS all'indirizzo. https://console.aws.amazon.com/sqs/

  3. Scegliere Crea coda.

  4. Nella pagina Crea coda, scegli quella corretta Regione AWS dall'elenco a discesa Region.

  5. Per Tipo, mantieni l'impostazione predefinita (Standard).

  6. Inserisci un Nome per la coda.

  7. Mantieni i valori predefiniti per tutte le altre impostazioni.

  8. Scegliere Crea coda.

Sviluppatore di app
AttivitàDescrizioneCompetenze richieste

Crea un ruolo IAM.

Questo ruolo IAM offre alle risorse API Gateway l'accesso completo ad Amazon SQS.

  1. Aprire la console IAM all'indirizzo https://console.aws.amazon.com/iam/.

  2. Nel pannello di navigazione seleziona Ruoli, quindi Crea ruolo.

  3. Per Trusted entity type (Tipo di entità attendibile), scegli Servizio AWS.

  4. Per Use Case, scegli API Gateway dall'elenco a discesa, quindi scegli Avanti, Avanti.

  5. Per Nome ruolo, inserisci AWSGatewayRoleForSQS e una descrizione opzionale, quindi scegli Crea ruolo.

  6. Nel riquadro Ruoli, cerca AWSGatewayRoleForSQS e seleziona la relativa casella di controllo.

  7. Nella sezione Policy di autorizzazioni, seleziona Aggiungi autorizzazioni, Collega policy.

  8. Cerca Amazon SQSFull Access e selezionalo.

  9. Scegli Aggiungi autorizzazioni.

  10. Nella sezione Riepilogo di AWSGatewayRoleForSQS, copia l'Amazon Resource Number (ARN). Utilizzerai questo ID in una fase successiva.

Sviluppatore di app, amministratore AWS
AttivitàDescrizioneCompetenze richieste

Crea un'API REST.

Questa è l'API REST a cui vengono inviate le richieste HTTP.

  1. Apri la console API Gateway all'indirizzo https://console.aws.amazon.com/apigateway/.

  2. Nella sezione API REST, scegli Build.

  3. Per il nome dell'API, inserisci un nome e una descrizione opzionale per l'API, mantieni tutte le altre impostazioni predefinite, quindi scegli Crea API.

Sviluppatore di app

Connetti API Gateway ad Amazon SQS.

Questo passaggio consente al messaggio di fluire dall'interno del corpo della richiesta HTTP ad Amazon SQS.

  1. Nella console API Gateway, scegli l'API che hai creato.

  2. Nella pagina Risorse, nella sezione Metodi, scegli Crea metodo.

  3. Per Metodo HTTP scegliere POST. 

  4. Per Tipo di integrazione, scegliete Servizio AWS.

  5. Per Regione AWS, scegli la regione in cui hai creato la coda SQS.

  6. Per Servizio AWS, scegli Simple Queue Service (SQS).

  7. Per il metodo HTTP, scegli POST.

  8. Per il tipo di azione, scegli Usa l'override del percorso.

  9. <name of SQS queue>Per Path override, inserisci/<AWS account ID>.

  10. Per il ruolo Execution, incolla l'ARN del ruolo creato in precedenza.

  11. Scegli Crea metodo.

Sviluppatore di app
AttivitàDescrizioneCompetenze richieste

Prova l'API REST.

Esegui un test per verificare la configurazione mancante:

  1. Nella console API Gateway, scegli l'API REST che hai creato.

  2. Nel riquadro Risorse, scegli il metodo POST.

  3. Seleziona la scheda Test. (Usa la freccia destra se la scheda non è visualizzata.)

  4. Per Request body, incolla il seguente codice JSON:

    {
     "message": "lorem ipsum"
}

  5. Scegli Test (Esegui test).

    Riceverai un errore simile al seguente:

    <UnknownOperationException/>
Sviluppatore di app

Modifica l'integrazione dell'API per inoltrare correttamente la richiesta ad Amazon SQS.

Completa la configurazione per correggere l'errore di integrazione:

  1. Nella console API Gateway, scegli l'API che hai creato, quindi scegli POST.

  2. La sezione Method Execution mostra la mappatura visiva tra API Gateway e Amazon SQS. Da questa sezione, scegli Richiesta di integrazione, quindi scegli Modifica.

  3. Espandi la sezione delle intestazioni HTTP, quindi scegli il parametro Aggiungi intestazione della richiesta.

    • Per Nome, specificate Content-Type.

    • Per Mapped from, inserisci 'application/ '. x-www-form-urlencoded Assicurati di includere le virgolette singole.

    • Seleziona la casella di controllo Caching.

  4. Espandi la sezione Modelli di mappatura.

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

    • Per Tipo di contenuto, inserisci application/json.

    • Per Template body, incolla questo codice:

      Action=SendMessage&MessageBody=$input.body

    • Scegli Save (Salva).

Sviluppatore di app

Testa e convalida il messaggio in Amazon SQS.

Esegui un test per confermare che il test è stato completato con successo:

  1. Nella console API Gateway, scegli l'API REST che hai creato.

  2. Nel riquadro Risorse, scegli il metodo POST.

  3. Seleziona la scheda Test. (Usa la freccia destra se la scheda non è visualizzata.)

  4. Per Request body, incolla il seguente codice JSON:

    {
     "message": "lorem ipsum"
}

  5. Scegli Test (Esegui test).

  6. Apri la console Amazon SQS.

  7. Nel riquadro di navigazione, scegli Code, quindi scegli la tua coda.

  8. Scegli Invia e ricevi messaggi.

  9. Scegli Sondaggio per i messaggi.

  10. Scegliere Message (Messaggio). Dovrebbe mostrare quanto segue:

    Body { "message": "lorem ipsum" }
Sviluppatore di app

Prova API Gateway con un carattere speciale.

Esegui un test che includa caratteri speciali (come &) che non sono accettabili in un messaggio:

  1. Nella console API Gateway, scegli la tua API.

  2. Ripeti il test del passaggio precedente utilizzando il seguente codice JSON:

    {
     "message": "lorem ipsum &"
}

  3. Scegli Test (Esegui test).

    Riceverai un errore come il seguente:

    {
  "Error": {
    "Code": "AccessDenied",
    "Message": "Access to the resource https://sqs.us-east-2.amazonaws.com/976166761794/Apg2 is denied.",
    "Type": "Sender"
  },
  "RequestId": "e83c9c67-bcf6-5e9a-91e9-c737094b17ab"
}

Questo perché i caratteri speciali non sono supportati per impostazione predefinita nel corpo del messaggio. Nel passaggio successivo, configurerai API Gateway per supportare i caratteri speciali. Per ulteriori informazioni sulle conversioni dei tipi di contenuto, consulta la documentazione di API Gateway.

Sviluppatore di app

Modifica la configurazione dell'API per supportare i caratteri speciali.

Modifica la configurazione per accettare caratteri speciali nel messaggio:

  1. Nella console API Gateway, scegli l'API che hai creato, quindi scegli POST.

  2. Scegli Richiesta di integrazione, quindi seleziona Modifica.

  3. Modifica la gestione dei contenuti in Converti in testo.

  4. Nella sezione Modelli di mappatura:

    • Per Tipo di contenuto, inserisci application/json.

    • Per il corpo del modello, specificare:

      Action=SendMessage&MessageBody=$util.urlEncode($input.body)

    • Scegli Save (Salva).

  5. Seleziona la scheda Test.

  6. Per Request body, inserisci il codice JSON di cui hai parlato in precedenza:

    {
     " message": "lorem ipsum &" }

  7. Scegli Test (Esegui test).

  8. Apri la console Amazon SQS.

  9. Seleziona la coda, quindi scegli Invia e ricevi messaggi, Sondaggio per i messaggi, Invia messaggio come prima.

Il nuovo messaggio deve includere il carattere speciale.

Sviluppatore di app
AttivitàDescrizioneCompetenze richieste

Implementa l'API.

Per distribuire l'API REST:

  1. Apri la console API Gateway.

  2. Scegliere l'API.

  3. Seleziona Deploy API (Distribuisci API). Per ulteriori informazioni su questo passaggio, consulta la documentazione di API Gateway.

Sviluppatore di app

Esegui il test con uno strumento esterno.

Esegui un test con uno strumento esterno per confermare che il messaggio sia stato ricevuto correttamente:

  1. Apri uno strumento come Postman, Insomnia o cURL.

  2. Esegui la tua API.

  3. Apri la console Amazon SQS.

  4. Seleziona la tua coda.

  5. Carica i messaggi per vedere il nuovo messaggio.

Sviluppatore di app
AttivitàDescrizioneCompetenze richieste

Eliminare l'API.

Nella console API Gateway, scegli l'API che hai creato, quindi scegli Elimina.

Sviluppatore di app

Elimina il ruolo IAM.

Sulla console IAM, nel riquadro Ruoli, seleziona AWSGatewayRoleForSQS, quindi scegli Elimina.

Sviluppatore di app

Elimina la coda SQS.

Sulla console Amazon SQS, nel riquadro Code, scegli la coda SQS che hai creato, quindi scegli Elimina.

Sviluppatore di app

Risorse correlate