Terapkan WebSocket APIs di API Gateway

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

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.

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

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 APIs. Untuk informasi selengkapnya, lihat Nama domain khusus untuk REST publik APIs 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 di API Gateway.

Membuat penerapan WebSocket API menggunakan AWS CLI

Perintah create-deployment berikut membuat deployment:

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

Outputnya akan terlihat seperti berikut:

{
    "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.

Perintah create-stage berikut membuat tahap baru dan mengaitkannya dengan penerapan:

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

Outputnya terlihat seperti berikut:

{
    "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": {}
}

Anda juga dapat menggunakan kembali tahap yang ada dengan memperbarui deploymentId properti stage dengan ID penerapan () deployment-id yang baru dibuat. Perintah update-stage berikut memperbarui ID penyebaran tahap:

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: