Siapkan integrasi proxy HTTP dengan streaming respons payload di API Gateway

Saat mengatur streaming payload respons, Anda menentukan mode transfer respons dalam permintaan integrasi metode Anda. Anda mengonfigurasi setelan ini dalam permintaan integrasi untuk mengontrol perilaku API Gateway sebelum dan selama respons integrasi. Saat Anda menggunakan streaming respons, Anda dapat mengonfigurasi batas waktu integrasi hingga 15 menit.

Saat Anda menggunakan streaming respons payload dengan HTTP_PROXY integrasi, API Gateway tidak akan mengirim kode status respons HTTP atau header respons HTTP apa pun hingga sepenuhnya menerima semua header.

Buat integrasi proxy HTTP dengan streaming respons payload

Prosedur berikut menunjukkan cara mengimpor API baru dengan responseTransferMode set keSTREAM. Jika Anda memiliki API integrasi yang ada dan ingin memodifikasinyaresponseTransferMode, lihatPerbarui mode transfer respons untuk integrasi proxy HTTP.

Konsol Manajemen AWS

Untuk membuat integrasi proxy HTTP dengan streaming respons payload

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

2. Pilih REST API.

3. Pilih Buat sumber daya.

4. Untuk Nama sumber daya, masukkan streaming.

5. Pilih Buat sumber daya.

6. Dengan sumber daya /streaming yang dipilih, pilih Create method.

7. Untuk jenis Metode, pilih APAPUN.

8. Untuk jenis Integrasi, pilih HTTP.

9. Pilih integrasi proxy HTTP.

10. Untuk mode transfer Respons, pilih Streaming.

11. Untuk metode HTTP, pilih metode.

12. Untuk URL Endpoint, masukkan titik akhir integrasi. Pastikan Anda memilih titik akhir yang menghasilkan muatan besar untuk dialirkan kembali kepada Anda.

13. Pilih metode Buat.

Setelah Anda membuat metode, terapkan API Anda.

Untuk men-deploy API Anda

1. Pilih Deploy API.

2. Untuk Stage, pilih New stage.

3. Untuk nama Panggung, masukkanprod.

4. (Opsional) Untuk Deskripsi, masukkan deskripsi.

5. Pilih Deploy.

AWS CLI

Untuk membuat API baru dengan streaming respons payload

1. Salin file Open API berikut, lalu simpan sebagai fileResponseStreamDemoSwagger.yaml. Dalam file ini, responseTransferMode diatur keSTREAM. Titik akhir integrasi diatur kehttps://example.com, tetapi kami menyarankan Anda memodifikasinya ke titik akhir yang menghasilkan muatan besar untuk dialirkan kembali kepada Anda.

   openapi: "3.0.1"
   info:
     title: "ResponseStreamingDemo"
     version: "2025-04-28T17:28:25Z"
   servers:
   - url: "{basePath}"
     variables:
       basePath:
         default: "prod"
   paths:
     /streaming:
       get:
         x-amazon-apigateway-integration:
           httpMethod: "GET"
           uri: "https://example.com"
           type: "http_proxy"
           timeoutInMillis: 900000
           responseTransferMode: "STREAM"

2. Gunakan import-rest-api perintah berikut untuk mengimpor definisi OpenAPI Anda:

   aws apigateway import-rest-api \
     --body 'fileb://~/ResponseStreamDemoSwagger.yaml' \
     --parameters endpointConfigurationTypes=REGIONAL \
     --region us-west-1

3. Gunakan create-deployment perintah berikut untuk menerapkan API baru Anda ke panggung:

   aws apigateway create-deployment \
     --rest-api-id a1b2c3 \
     --stage-name prod \
     --region us-west-1

Perbarui mode transfer respons untuk integrasi proxy HTTP

Prosedur berikut menunjukkan cara memperbarui mode transfer respons untuk integrasi proxy HTTP.

Konsol Manajemen AWS

Untuk memperbarui mode transfer respons untuk integrasi proxy HTTP

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

2. Pilih REST API.

3. Pilih metode.

4. Pada tab Permintaan integrasi, di bawah Pengaturan permintaan integrasi, pilih Edit.

5. Untuk mode transfer Respons, pilih Streaming.

6. Pilih Simpan.

Setelah memperbarui metode, terapkan API Anda.

Untuk men-deploy API Anda

1. Pilih Deploy API.

2. Untuk Stage, pilih New stage.

3. Untuk nama Panggung, masukkanprod.

4. (Opsional) Untuk Deskripsi, masukkan deskripsi.

5. Pilih Deploy.

AWS CLI

update-integrationPerintah berikut memperbarui mode transfer integrasi dari BUFFERED keSTREAM. Untuk yang ada APIs, mode transfer respons untuk semua integrasi diatur keBUFFERED.

aws apigateway update-integration \
 --rest-api-id a1b2c3 \
 --resource-id aaa111 \
 --http-method GET \
 --patch-operations "op='replace',path='/responseTransferMode',value=STREAM" \
 --region us-west-1

Anda perlu menerapkan ulang API agar perubahan diterapkan. Jika Anda menyesuaikan batas waktu integrasi, nilai batas waktu ini akan dihapus, karena API Gateway mengalirkan respons Anda hingga 5 menit.

update-integrationPerintah berikut memperbarui mode transfer integrasi dari STREAM keBUFFERED:

aws apigateway update-integration \
 --rest-api-id a1b2c3 \
 --resource-id aaa111 \
 --http-method GET \
 --patch-operations "op='replace',path='/responseTransferMode',value=BUFFERED" \
 --region us-west-1

Anda perlu menerapkan ulang API agar perubahan diterapkan.