Menerapkan WebSocket API di API Gateway

Setelah membuat WebSocket API Anda, Anda harus menerapkannya agar tersedia bagi pengguna Anda untuk dipanggil.

Untuk menerapkan API, Anda membuat penerapan API dan mengaitkannya dengan sebuah panggung. Setiap tahap adalah snapshot dari API dan tersedia untuk aplikasi klien untuk dipanggil.

penting

Setiap kali Anda memperbarui API, Anda harus menerapkannya kembali. Perubahan pada apa pun selain pengaturan tahap memerlukan pemindahan, termasuk modifikasi pada sumber daya berikut:

• Rute

• Integrasi

• Pengotorisasi

Secara default, Anda dibatasi hingga 10 tahap untuk setiap API. Kami menyarankan Anda menggunakan kembali tahapan untuk penerapan Anda.

Untuk memanggil WebSocket API yang diterapkan, klien mengirim pesan ke URL API. URL ditentukan oleh nama host dan nama panggung API.

catatan

API Gateway akan mendukung payload hingga 128 KB dengan ukuran frame maksimal 32 KB. Jika pesan melebihi 32 KB, itu harus dibagi menjadi beberapa frame, masing-masing 32 KB atau lebih kecil.

Menggunakan nama domain default API, URL (misalnya) WebSocket API dalam tahap tertentu ({stageName}) adalah dalam format berikut:

wss://{api-id}.execute-api.{region}.amazonaws.com/{stageName}

Untuk membuat URL WebSocket API lebih user-friendly, Anda dapat membuat nama domain kustom (misalnya,api.example.com) untuk mengganti nama host default API. Proses konfigurasi sama dengan REST API. Untuk informasi selengkapnya, lihat Nama domain khusus untuk REST API di API Gateway.

Tahapan memungkinkan kontrol versi yang kuat dari API Anda. Misalnya, Anda dapat menerapkan API ke test stage dan prod stage, dan menggunakan test stage sebagai test build dan menggunakan prod stage sebagai build stabil. Setelah pembaruan lulus tes, Anda dapat mempromosikan test panggung ke prod panggung. Promosi dapat dilakukan dengan memindahkan API ke panggung. prod Untuk detail lebih lanjut tentang tahapan, lihatSiapkan panggung untuk REST API.

Membuat penerapan WebSocket API menggunakan AWS CLI

Untuk digunakan AWS CLI untuk membuat deployment, gunakan perintah create-deployment seperti yang ditunjukkan pada contoh berikut:

aws apigatewayv2 --region us-east-1 create-deployment --api-id aabbccddee

Contoh output:

{
    "DeploymentId": "fedcba",
    "DeploymentStatus": "DEPLOYED",
    "CreatedDate": "2018-11-15T06:49:09Z"
}

API yang diterapkan tidak dapat dipanggil sampai Anda mengaitkan penerapan dengan tahapan. Anda dapat membuat tahap baru atau menggunakan kembali tahap yang telah Anda buat sebelumnya.

Untuk membuat tahap baru dan mengaitkannya dengan penerapan, gunakan perintah create-stage seperti yang ditunjukkan pada contoh berikut:

aws apigatewayv2 --region us-east-1 create-stage --api-id aabbccddee --deployment-id fedcba --stage-name test

Contoh output:

{
    "StageName": "test",
    "CreatedDate": "2018-11-15T06:50:28Z",
    "DeploymentId": "fedcba",
    "DefaultRouteSettings": {
        "MetricsEnabled": false,
        "ThrottlingBurstLimit": 5000,
        "DataTraceEnabled": false,
        "ThrottlingRateLimit": 10000.0
    },
    "LastUpdatedDate": "2018-11-15T06:50:28Z",
    "StageVariables": {},
    "RouteSettings": {}
}

Untuk menggunakan kembali tahap yang ada, perbarui deploymentId properti stage dengan ID penerapan ({deployment-id}) yang baru dibuat dengan menggunakan perintah update-stage.

 aws apigatewayv2 update-stage --region {region} \
    --api-id {api-id} \ 
    --stage-name {stage-name} \ 
    --deployment-id {deployment-id}

Membuat penerapan WebSocket API menggunakan konsol API Gateway

Untuk menggunakan konsol API Gateway untuk membuat penerapan WebSocket API:

1. Masuk ke konsol API Gateway dan pilih API.

2. Pilih Deploy API.

3. Pilih tahap yang diinginkan dari daftar dropdown atau masukkan nama tahap baru.