View a markdown version of this page

Tutorial: Membuat REST API sebagai proxy Amazon S3 - Amazon API Gateway
Menyiapkan izin IAM untuk API untuk memanggil tindakan Amazon S3Buat sumber daya API untuk mewakili sumber daya Amazon S3Mengekspos metode API untuk mencantumkan bucket Amazon S3 pemanggilMengekspos metode API untuk mengakses bucket Amazon S3Mengekspos metode API untuk mengakses objek Amazon S3 dalam bucket

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

Tutorial: Membuat REST API sebagai proxy Amazon S3

Sebagai contoh untuk menampilkan penggunaan REST API di API Gateway ke proxy Amazon S3, bagian ini menjelaskan cara membuat dan mengonfigurasi REST API untuk mengekspos operasi Amazon S3 berikut:

Anda mungkin ingin mengimpor API sampel sebagai proxy Amazon S3, seperti yang ditunjukkan padaDefinisi OpenAPI dari contoh API sebagai proxy Amazon S3. Sampel ini berisi metode yang lebih terbuka. Untuk petunjuk tentang cara mengimpor API menggunakan definisi OpenAPI, lihatKembangkan REST API menggunakan OpenAPI di API Gateway.

catatan

Untuk mengintegrasikan API Gateway API Anda dengan Amazon S3, Anda harus memilih wilayah di mana layanan API Gateway dan Amazon S3 tersedia. Untuk ketersediaan wilayah, lihat Titik Akhir dan Kuota Amazon API Gateway.

Topik

Menyiapkan izin IAM untuk API untuk memanggil tindakan Amazon S3

Untuk mengizinkan API memanggil tindakan Amazon S3, Anda harus memiliki kebijakan IAM yang sesuai yang dilampirkan ke peran IAM. Pada langkah ini, Anda membuat peran IAM baru.

Untuk membuat AWS peran eksekusi proxy layanan

  1. Masuk ke Konsol Manajemen AWS dan buka konsol IAM di https://console.aws.amazon.com/iam/.

  2. Pilih Peran.

  3. Pilih Buat peran.

  4. Pilih AWS layanan di bawah Pilih jenis entitas tepercaya, lalu pilih API Gateway dan pilih Iz inkan API Gateway untuk mendorong CloudWatch log ke Log.

  5. Pilih Berikutnya, lalu pilih Ber ikutnya.

  6. Untuk Nama peran, masukkanAPIGatewayS3ProxyPolicy, lalu pilih Buat peran.

  7. Dalam daftar Peran, pilih peran yang baru saja Anda buat. Anda mungkin perlu menggulir atau menggunakan bilah pencarian untuk menemukan peran.

  8. Untuk peran yang dipilih, pilih tab Tambah izin.

  9. Pilih Lampirkan kebijakan dari daftar dropdown.

  10. Di bilah pencarian, masukkan AmazonS3FullAccess dan pilih Tambahkan izin.

    catatan

    Tutorial ini menggunakan kebijakan terkelola untuk kesederhanaan. Sebagai praktik terbaik, Anda harus membuat kebijakan IAM sendiri untuk memberikan izin minimum yang diperlukan.

  11. Perhatikan Role AR N yang baru dibuat, Anda akan menggunakannya nanti.

Buat sumber daya API untuk mewakili sumber daya Amazon S3

Anda menggunakan sumber daya root (/) API sebagai wadah bucket Amazon S3 pemanggil yang diautentikasi. Anda juga membuat Item sumber daya Folder dan untuk mewakili bucket Amazon S3 tertentu dan objek Amazon S3 tertentu, masing-masing. Nama folder dan kunci objek akan ditentukan, dalam bentuk parameter jalur sebagai bagian dari URL permintaan, oleh pemanggil.

catatan

Saat mengakses objek yang kunci objeknya termasuk / atau karakter khusus lainnya, karakter harus dikodekan URL. Misalnya, test/test.txt harus dikodekan ketest%2Ftest.txt.

Untuk membuat sumber daya API yang menampilkan fitur layanan Amazon S3

  1. Sama seperti Wilayah AWS Anda membuat bucket Amazon S3 Anda, buat API bernama MyS3. Sumber daya root API ini (/) mewakili layanan Amazon S3. Pada langkah ini, Anda membuat dua sumber daya tambahan/{folder} dan/{item}.

  2. Pilih Buat sumber daya.

  3. Tetap matikan sumber daya Proxy.

  4. Untuk jalur sumber daya, pilih/.

  5. Untuk Nama sumber daya, masukkan {folder}.

  6. Jangan cent ang CORS (Cross Origin Resource Sharing).

  7. Pilih Buat sumber daya.

  8. Pilih sumber daya/{folder}, lalu pilih Buat sumber daya.

  9. Gunakan langkah-langkah sebelumnya untuk membuat sumber daya anak dari/{folder} bernama{item}.

    API akhir Anda akan terlihat mirip dengan yang berikut:

    Buat API di API Gateway sebagai proxy Amazon S3

Mengekspos metode API untuk mencantumkan bucket Amazon S3 pemanggil

Mendapatkan daftar bucket Amazon S3 dari pemanggil melibatkan pemanggilan tindakan GET Service di Amazon S3. Pada sumber daya root API, (/), buat metode GET. Konfigurasikan metode GET untuk berintegrasi dengan Amazon S3, sebagai berikut.

Untuk membuat dan menginisialisasi metode GET/API

  1. Pilih sumber daya/, lalu pilih Metode Buat.

  2. Untuk jenis metode, pilih GET.

  3. Untuk Jenis Integrasi, pilih Layanan AWS.

  4. Untuk Wilayah AWS, pilih Wilayah AWS tempat Anda membuat bucket Amazon S3 Anda.

  5. Untuk Layanan AWS, pilih Layanan Penyimpanan Sederhana Amazon.

  6. Biarkan AWS subdomain kosong.

  7. Untuk metode HTTP, pilih GET.

  8. Untuk Jenis tindakan, pilih Gunakan penggantian jalur.

    Dengan penggantian jalur, API Gateway meneruskan permintaan klien ke Amazon S3 sebagai permintaan gaya jalur API REST Amazon S3 yang sesuai, di mana sumber daya Amazon S3 dinyatakan oleh jalur sumber daya dari pola. s3-host-name/bucket/key API Gateway menyet s3-host-name el dan meneruskan klien bucket yang ditentukan dan key dari klien ke Amazon S3.

  9. Untuk Path override, masukkan/.

  10. Untuk peran eksekusi, masukkan peran ARN untukAPIGatewayS3ProxyPolicy.

  11. Pilih Set elan permintaan metode.

    Anda menggunakan pengaturan permintaan metode untuk mengontrol siapa yang dapat memanggil metode ini dari API Anda.

  12. Untuk Otorisasi, dari menu dropdown, pilihAWS_IAM.

    Deklarasikan jenis respons metode

  13. Pilih Metode Buat.

Pengaturan ini mengintegrasikan GET https://your-api-host/stage/ permintaan frontend dengan back GET https://your-s3-host/ end.

Agar API Anda mengembalikan respons dan pengecualian yang berhasil dengan benar ke pemanggil, Anda mendeklarasikan tanggapan 200, 400, dan 500 dalam respons Metode. Anda menggunakan pemetaan default untuk 200 tanggapan sehingga tanggapan backend dari kode status yang tidak dideklarasikan di sini akan dikembalikan ke pemanggil sebagai 200.

Untuk mendeklarasikan tipe respons untuk metode GET/

  1. Pada tab Respon se Metode, di bawah Response 200, pilih Edit.

  2. Pilih Tambahkan header dan lakukan hal berikut:

    1. Untuk nama Header, masukkanContent-Type.

    2. Pilih Tambahkan header.

    Ulangi langkah-langkah ini untuk membuat Timestamp header dan Content-Length header.

  3. Pilih Simpan.

  4. Pada tab respons metode, di bawah respons metode, pilih Buat respons.

  5. Untuk kode status HTTP, masukkan 400.

    Anda tidak menetapkan header apa pun untuk respons ini.

  6. Pilih Simpan.

  7. Ulangi langkah-langkah berikut untuk membuat respons 500.

    Anda tidak menetapkan header apa pun untuk respons ini.

Karena respons integrasi yang berhasil dari Amazon S3 mengembalikan bucket list sebagai payload XML dan respons metode default dari API Gateway mengembalikan muatan JSON, Anda harus memetakan nilai parameter Content-Type header backend ke mitra frontend. Jika tidak, klien akan menerima application/json untuk jenis konten ketika badan respons sebenarnya adalah string XML. Prosedur berikut menunjukkan cara mengaturnya. Selain itu, Anda juga ingin menampilkan parameter header lainnya kepada klien, seperti Tanggal dan Content-Length.

Untuk mengatur pemetaan header respons untuk metode GET/

  1. Pada tab Resp ons Integrasi, di bawah Def ault - Response, pilih Edit.

  2. Untuk Content-Length header, masukkan integration.response.header.Content-Length untuk nilai pemetaan.

  3. Untuk Content-Type header, masukkan integration.response.header.Content-Type untuk nilai pemetaan.

  4. Untuk header Timestamp, masukkan integration.response.header.Date untuk nilai pemetaan.

  5. Pilih Simpan. Hasilnya akan terlihat mirip dengan berikut ini:

    Petakan header respons integrasi ke header respons metode

  6. Pada tab Respon integrasi, di bawah Respons integrasi, pilih Buat respons.

  7. Untuk regex status HTTP, masukkan. 4\d{2} Ini memetakan semua kode status respons HTTP 4xx ke respons metode.

  8. Untuk Kode status respons Metode, pilih400.

  9. Pilih Buat.

  10. Ulangi langkah-langkah berikut untuk membuat respons integrasi untuk respons metode 500. Untuk regex status HTTP, masukkan. 5\d{2}

Sebagai praktik yang baik, Anda dapat menguji API yang telah Anda konfigurasikan sejauh ini.

Untuk menguji metode GET/

  1. Pilih tab Tes. Anda mungkin perlu memilih tombol panah kanan untuk menampilkan tab.

  2. Pilih Uji. Hasilnya akan terlihat seperti gambar berikut:

    Uji root API DAPATKAN hasil bucket

Mengekspos metode API untuk mengakses bucket Amazon S3

Untuk bekerja dengan bucket Amazon S3, Anda mengekspos GET metode pada sumber daya/{folder} untuk mencantumkan objek dalam bucket. Instruksinya mirip dengan yang dijelaskan dalamMengekspos metode API untuk mencantumkan bucket Amazon S3 pemanggil. Untuk metode lainnya, Anda dapat mengimpor contoh API di sini,Definisi OpenAPI dari contoh API sebagai proxy Amazon S3.

Untuk mengekspos metode GET pada sumber daya folder

  1. Pilih sumber daya/{folder}, lalu pilih Metode Buat.

  2. Untuk jenis metode, pilih GET.

  3. Untuk Jenis Integrasi, pilih Layanan AWS.

  4. Untuk Wilayah AWS, pilih Wilayah AWS tempat Anda membuat bucket Amazon S3 Anda.

  5. Untuk Layanan AWS, pilih Layanan Penyimpanan Sederhana Amazon.

  6. Biarkan AWS subdomain kosong.

  7. Untuk metode HTTP, pilih GET.

  8. Untuk Jenis tindakan, pilih Gunakan penggantian jalur.

  9. Untuk Path override, masukkan{bucket}.

  10. Untuk peran eksekusi, masukkan peran ARN untukAPIGatewayS3ProxyPolicy.

  11. Pilih Metode Buat.

Anda menetapkan parameter {folder} path di URL titik akhir Amazon S3. Anda perlu memet {folder} akan parameter jalur dari permintaan metode ke parameter {bucket} jalur permintaan integrasi.

Untuk memet akan {folder} ke {bucket}

  1. Pada tab Per mintaan integrasi, di bawah Peng aturan permintaan integrasi, pilih Edit.

  2. Pilih parameter jalur URL, lalu pilih Tambahkan parameter jalur.

  3. Untuk Nama, masukkan bucket.

  4. Untuk Dipetakan dari, masukkanmethod.request.path.folder.

  5. Pilih Simpan.

Sekarang, Anda menguji API Anda.

Untuk menguji metode/{folder} GET.

  1. Pilih tab Tes. Anda mungkin perlu memilih tombol panah kanan untuk menampilkan tab.

  2. Di bawah Path , untuk folder, masukkan nama bucket Anda.

  3. Pilih Uji.

    Hasil tes akan berisi daftar objek di bucket Anda.

    Uji metode GET untuk membuat bucket Amazon S3.

Mengekspos metode API untuk mengakses objek Amazon S3 dalam bucket

Amazon S3 mendukung tindakan GET, DELETE, HEAD, OPTIONS, POST dan PUT untuk mengakses dan mengelola objek dalam bucket tertentu. Dalam tutorial ini, Anda mengekspos GET metode pada {folder}/{item} sumber daya untuk mendapatkan gambar dari bucket. Untuk aplikasi sumber {folder}/{item} daya lainnya, lihat contoh API,Definisi OpenAPI dari contoh API sebagai proxy Amazon S3.

Untuk mengekspos metode GET pada sumber daya item

  1. Pilih sumber daya/{item}, lalu pilih Metode Buat.

  2. Untuk jenis metode, pilih GET.

  3. Untuk Jenis Integrasi, pilih Layanan AWS.

  4. Untuk Wilayah AWS, pilih Wilayah AWS tempat Anda membuat bucket Amazon S3 Anda.

  5. Untuk Layanan AWS, pilih Layanan Penyimpanan Sederhana Amazon.

  6. Biarkan AWS subdomain kosong.

  7. Untuk metode HTTP, pilih GET.

  8. Untuk Jenis tindakan, pilih Gunakan penggantian jalur.

  9. Untuk Path override, masukkan {bucket}/{object}.

  10. Untuk peran eksekusi, masukkan peran ARN untukAPIGatewayS3ProxyPolicy.

  11. Pilih Metode Buat.

Anda mengatur parameter {folder} dan {item} jalur di URL titik akhir Amazon S3. Anda perlu memetakan parameter jalur permintaan metode ke parameter jalur permintaan integrasi.

Dalam langkah ini, Anda melakukan hal berikut:

  • Petakan parameter {folder} jalur dari permintaan metode ke parameter {bucket} path dari permintaan integrasi.

  • Petakan parameter {item} jalur dari permintaan metode ke parameter {object} path dari permintaan integrasi.

Untuk mem etakan {folder} ke {bucket} dan {item} ke {object}

  1. Pada tab Per mintaan integrasi, di bawah Peng aturan permintaan integrasi, pilih Edit.

  2. Pilih parameter jalur URL.

  3. Pilih Tambahkan parameter jalur.

  4. Untuk Nama, masukkan bucket.

  5. Untuk Dipetakan dari, masukkanmethod.request.path.folder.

  6. Pilih Tambahkan parameter jalur.

  7. Untuk Nama, masukkan object.

  8. Untuk Dipetakan dari, masukkanmethod.request.path.item.

  9. Pilih Simpan.

Untuk menguji metode/{folder}/{item} GET.

  1. Pilih tab Tes. Anda mungkin perlu memilih tombol panah kanan untuk menampilkan tab.

  2. Di bawah Path , untuk folder, masukkan nama bucket Anda.

  3. Di bawah Path , untuk item, masukkan nama item.

  4. Pilih Uji.

    Badan respons akan berisi isi item.

    Uji metode GET untuk membuat bucket Amazon S3.

    Permintaan mengembalikan teks biasa (“Hello world”) dengan benar sebagai konten file yang ditentukan (test.txt) dalam bucket Amazon S3 yang diberikan (amzn-s3-demo-bucket).

Untuk mengunduh atau mengunggah file biner, yang di API Gateway dianggap sebagai hal selain konten JSON yang dikodekan utf-8, pengaturan API tambahan diperlukan. Ini diuraikan sebagai berikut:

Untuk mengunduh atau mengunggah file biner dari S3

  1. Daftarkan jenis media dari file yang terpengaruh ke biner APIMediaTypes. Anda dapat melakukan ini di konsol:

    1. Pilih pengaturan API untuk API.

    2. Di bawah Jenis media biner, pilih Kelola jenis media.

    3. Pilih Tambahkan jenis media biner, lalu masukkan jenis media yang diperlukan, misalnya,image/png.

    4. Pilih Simpan perubahan untuk menyimpan pengaturan.

  2. Tambahkan header Content-Type (for upload) and/or Accept (for download) ke permintaan metode untuk meminta klien menentukan jenis media biner yang diperlukan dan memetakannya ke permintaan integrasi.

  3. Set el Penanganan Konten ke Passthrough dalam permintaan integrasi (untuk unggahan) dan dalam respons integrasi (untuk unduhan). Pastikan tidak ada template pemetaan yang ditentukan untuk jenis konten yang terpengaruh. Untuk informasi selengkapnya, lihat Transformasi data untuk REST API di API Gateway.

Batas ukuran payload adalah 10 MB. Lihat Kuota untuk mengonfigurasi dan menjalankan REST API di API Gateway.

Pastikan file di Amazon S3 memiliki jenis konten yang benar ditambahkan sebagai metadata file. Untuk konten media yang dapat dial Content-Disposition:inline irkan, mungkin juga perlu ditambahkan ke metadata.

Untuk informasi selengkapnya tentang dukungan biner di API Gateway, lihatKonversi jenis konten di API Gateway.