Tutorial: Buat WebSocket API dengan AWS integrasi

Untuk membuat AWS CloudFormation tumpukan

1. Buka AWS CloudFormation konsol di https://console.aws.amazon.com/cloudformation.

2. Pilih Buat tumpukan kemudian pilih Dengan sumber daya baru (standar).

3. Untuk Tentukan templat, pilih Unggah file templat.

4. Pilih template yang Anda unduh.

5. Pilih Selanjutnya.

6. Untuk nama Stack, masukkan websocket-step-functions-tutorial dan kemudian pilih Berikutnya.

7. Untuk opsi Konfigurasi tumpukan, pilih Berikutnya.

8. Untuk Kemampuan, akui bahwa AWS CloudFormation dapat membuat IAM sumber daya di akun Anda.

9. Pilih Kirim.

Untuk membuat WebSocket API

1. Masuk ke konsol API Gateway di https://console.aws.amazon.com/apigateway.

2. Pilih Buat API. Kemudian untuk WebSocket API, pilih Build.

3. Untuk APInama, masukkanwebsocket-step-functions-tutorial.

4. Untuk ekspresi pemilihan Rute, masukkanrequest.body.action.

   Ekspresi pemilihan rute menentukan rute yang API dipanggil Gateway saat klien mengirim pesan.

5. Pilih Selanjutnya.

6. Untuk rute Predefined, pilih Add $connect, Add $disconnect, Add $default.

   Rute $connect dan $disconnect adalah rute khusus yang dipanggil API Gateway secara otomatis saat klien terhubung atau terputus dari file. API APIGateway memanggil rute $default ketika tidak ada rute lain yang cocok dengan permintaan. Anda akan membuat rute khusus untuk terhubung ke Step Functions setelah Anda membuatAPI.

7. Pilih Selanjutnya.

8. Untuk Integrasi untuk $connect, lakukan hal berikut:

   1. Untuk jenis Integrasi, pilih Lambda.

   2. Untuk fungsi Lambda, pilih fungsi Lambda $connect yang sesuai yang Anda buat AWS CloudFormation di Langkah 1. Nama fungsi Lambda harus dimulai dengan. websocket-step

9. Untuk Integrasi untuk $disconnect, lakukan hal berikut:

   1. Untuk jenis Integrasi, pilih Lambda.

   2. Untuk fungsi Lambda, pilih fungsi Lambda $disconnect yang sesuai yang Anda buat di Langkah 1. AWS CloudFormation Nama fungsi Lambda harus dimulai dengan. websocket-step

10. Untuk Integrasi untuk $ default, pilih mock.

    Dalam integrasi tiruan, API Gateway mengelola respons rute tanpa backend integrasi.

11. Pilih Selanjutnya.

12. Tinjau tahap yang dibuat API Gateway untuk Anda. Secara default, API Gateway membuat tahap bernama produksi dan secara otomatis menyebarkan Anda API ke tahap itu. Pilih Selanjutnya.

13. Pilih Buat dan terapkan.

Untuk membuat otorisasi Lambda

1. Masuk ke konsol API Gateway di https://console.aws.amazon.com/apigateway.

2. Di panel navigasi utama, pilih Authorizers.

3. Pilih Buat Authorizer.

4. Untuk nama Authorizer, masukkanLambdaAuthorizer.

5. Untuk Authorizer ARN, masukkan nama otorisasi yang dibuat oleh template. AWS CloudFormation Nama harus dimulai denganwebsocket-step-functions-tutorial-AuthorizerHandler.

   catatan

   Kami menyarankan Anda untuk tidak menggunakan contoh otorisasi ini untuk produksi APIs Anda.

6. Untuk tipe sumber Identity, pilih Header. Untuk Kunci, masukkan Authorization.

7. Pilih Buat Authorizer.

Untuk melampirkan otorisasi ke rute $connect

1. Di panel navigasi utama, pilih Rute.

2. Pilih rute $connect.

3. Di bagian Pengaturan permintaan rute, pilih Edit.

4. Untuk Otorisasi, pilih menu tarik-turun, lalu pilih otorisasi permintaan Anda.

5. Pilih Simpan perubahan.

Untuk membuat integrasi tiruan

1. Masuk ke konsol API Gateway di https://console.aws.amazon.com/apigateway.

2. Pilih rute $ default, lalu pilih tab Permintaan integrasi.

3. Untuk templat Permintaan, pilih Edit.

4. Untuk ekspresi pemilihan Template, masukkan200, lalu pilih Edit.

5. Pada tab Permintaan integrasi, untuk templat Permintaan, pilih Buat templat.

6. Untuk kunci Template, masukkan200.

7. Untuk menghasilkan template, masukkan template pemetaan berikut:

   {"statusCode": 200}

   Pilih Buat templat.

   Hasilnya akan terlihat seperti berikut ini:

   

8. Pada panel rute $default, pilih Aktifkan komunikasi dua arah.

9. Pilih tab Integration response, lalu pilih Create Integration Response.

10. Untuk tombol Respons, masukkan$default.

11. Untuk ekspresi pemilihan Template, masukkan200.

12. Pilih Buat respons.

13. Di bawah Templat respons, pilih Buat templat.

14. Untuk kunci Template, masukkan200.

15. Untuk template Response, masukkan template pemetaan berikut:

    {"Use the sendmessage route to send a message. Connection ID: $context.connectionId"}

16. Pilih Buat templat.

    Hasilnya akan terlihat seperti berikut ini:

    

Untuk membuat integrasi non-proxy

1. Masuk ke konsol API Gateway di https://console.aws.amazon.com/apigateway.

2. Pilih Buat rute.

3. Untuk kunci Rute, masukkansendmessage.

4. Untuk jenis Integrasi, pilih AWS layanan.

5. Untuk AWS Wilayah, masukkan Wilayah tempat Anda menerapkan AWS CloudFormation template Anda.

6. Untuk AWS layanan, pilih Step Functions.

7. Untuk HTTPmetode, pilih POST.

8. Untuk nama Action, masukkanStartExecution.

9. Untuk peran Eksekusi, masukkan peran eksekusi yang dibuat oleh AWS CloudFormation template. Namanya seharusnya WebsocketTutorialApiRole.

10. Pilih Buat rute.

Untuk membuat template pemetaan

1. Pilih rute sendmessage, lalu pilih tab Permintaan integrasi.

2. Di bagian Permintaan template, pilih Edit.

3. Untuk ekspresi pemilihan Template, masukkan\$default.

4. Pilih Edit.

5. Di bagian Permintaan template, pilih Buat template.

6. Untuk kunci Template, masukkan\$default.

7. Untuk menghasilkan template, masukkan template pemetaan berikut:

   #set($domain = "$context.domainName")
   #set($stage = "$context.stage")
   #set($body = $input.json('$'))
   #set($getMessage = $util.parseJson($body))
   #set($mymessage = $getMessage.message)
   {
   "input": "{\"domain\": \"$domain\", \"stage\": \"$stage\", \"message\": \"$mymessage\"}",
   "stateMachineArn": "arn:aws:states:us-east-2:123456789012:stateMachine:WebSocket-Tutorial-StateMachine"
   }

   Ganti stateMachineArn dengan mesin ARN negara yang dibuat oleh AWS CloudFormation.

   Template pemetaan melakukan hal berikut:

   • Menciptakan variabel $domain menggunakan variabel konteksdomainName.

   • Menciptakan variabel $stage menggunakan variabel konteksstage.

     $stageVariabel $domain dan diperlukan untuk membangun callbackURL.

   • Mengambil sendmessage JSON pesan masuk, dan mengekstrak message properti.

   • Menciptakan input untuk mesin negara. Input adalah domain dan tahap WebSocket API dan pesan dari sendmessage rute.

8. Pilih Buat templat.

   

Untuk menyebarkan API

1. Masuk ke konsol API Gateway di https://console.aws.amazon.com/apigateway.

2. Di panel navigasi utama, pilih Rute.

3. Pilih DeployAPI.

4. Untuk Panggung, pilih produksi.

5. (Opsional) Untuk deskripsi Deployment, masukkan deskripsi.

6. Pilih Deploy.

Untuk mendapatkan panggilan URL untuk Anda API

1. Pilih API Anda.

2. Pilih Tahapan, lalu pilih produksi.

3. Perhatikan API milik Anda WebSocket URL. URLSeharusnya terlihat sepertiwss://abcdef123.execute-api.us-east-2.amazonaws.com/production.

Untuk menguji koneksi ke API

1. Gunakan perintah berikut untuk terhubung ke AndaAPI. Pertama, Anda menguji koneksi dengan memanggil /ping jalur.

   wscat -c wss://abcdef123.execute-api.us-east-2.amazonaws.com/production -H "Authorization: Allow" --slash -P

   Connected (press CTRL+C to quit)

2. Masukkan perintah berikut untuk melakukan ping pada bingkai kontrol. Anda dapat menggunakan bingkai kontrol untuk tujuan keepalive dari sisi klien.

   /ping

   Hasilnya akan terlihat seperti berikut ini:

   < Received pong (data: "")

Untuk menguji API

1. Buka terminal baru dan jalankan wscat perintah lagi dengan parameter berikut.

   wscat -c wss://abcdef123.execute-api.us-east-2.amazonaws.com/production -H "Authorization: Allow"

   Connected (press CTRL+C to quit)

2. APIGateway menentukan rute mana yang akan dipanggil berdasarkan ekspresi pemilihan API permintaan rute Anda. Ekspresi pilih rute Anda API adalah$request.body.action. Akibatnya, API Gateway memanggil sendmessage rute saat Anda mengirim pesan berikut:

   {"action": "sendmessage", "message": "hello, from Step Functions!"}

   Mesin status Step Functions yang terkait dengan rute memanggil fungsi Lambda dengan pesan dan callback. URL Fungsi Lambda memanggil Manajemen API Gateway API dan mengirimkan pesan ke semua klien yang terhubung. Semua klien menerima pesan berikut:

   < hello, from Step Functions!

Untuk memutuskan sambungan dari API

• Tekan CTRL+C untuk memutuskan sambungan dari AndaAPI.

  Ketika klien terputus dari AndaAPI, API Gateway memanggil rute $disconnect AndaAPI. Integrasi Lambda untuk rute $disconnect Anda API menghapus ID koneksi dari DynamoDB.

Untuk menghapus WebSocket API

1. Masuk ke konsol API Gateway di https://console.aws.amazon.com/apigateway.

2. Pada APIshalaman, pilih websocket-api Anda.

3. Pilih Tindakan, pilih Hapus, lalu konfirmasikan pilihan Anda.

Untuk menghapus AWS CloudFormation tumpukan

1. Buka AWS CloudFormation konsol di https://console.aws.amazon.com/cloudformation.

2. Pilih AWS CloudFormation tumpukan Anda.

3. Pilih Hapus dan kemudian konfirmasikan pilihan Anda.