Memulai dengan AWS
Membangun Aplikasi Web Nirserver
dengan AWS Lambda, Amazon API Gateway, AWS Amplify, Amazon DynamoDB, dan Amazon Cognito
Modul 4: Men-deploy API RESTful
Anda akan menggunakan Amazon API Gateway untuk mengekspos fungsi Lambda yang dibangun di modul sebelumnya sebagai RESTful API
Gambaran Umum
Dalam modul ini, Anda akan menggunakan Amazon API Gateway untuk mengekspos fungsi Lambda yang dibangun di modul sebelumnya sebagai API RESTful. API ini akan dapat diakses di Internet publik. API ini akan diamankan menggunakan kolam pengguna Amazon Cognito yang Anda buat dalam modul sebelumnya. Dengan menggunakan konfigurasi ini, Anda kemudian akan mengubah situs web yang di-hosting secara statis menjadi aplikasi web yang dinamis dengan menambahkan JavaScript dari sisi klien yang membuat panggilan AJAX pada API yang terekspos.
Gambaran umum arsitektur
Diagram di atas menunjukkan bagaimana komponen Gateway API yang akan Anda bangun dalam modul ini berintegrasi dengan komponen lama yang Anda bangun sebelumnya. Item berwarna abu-abu adalah bagian yang telah Anda implementasikan dalam langkah sebelumnya.
Situs web statis yang Anda deploy dalam modul pertama telah memiliki halaman yang dikonfigurasi untuk berinteraksi dengan API yang akan Anda bangun dalam modul ini. Halaman di /ride.html memiliki antarmuka berbasis peta yang sederhana untuk meminta kendaraan unicorn. Setelah autentikasi menggunakan halaman /signin.html, pengguna Anda akan dapat memilih lokasi pengambilan mereka dengan mengklik lokasi pada peta lalu meminta perjalanan dengan memilih tombol "Minta Unicorn" di sudut kanan atas.
Modul ini akan berfokus pada langkah-langkah yang diperlukan untuk membangun komponen cloud API, tetapi jika Anda tertarik dengan cara kerja kode peramban yang memanggil API ini, Anda dapat memeriksa file ride.js dari situs web. Dalam hal ini, aplikasi menggunakan metode ajax() jQuery untuk membuat permintaan jarak jauh.
Waktu penyelesaian
15 menit
Layanan yang digunakan
Implementasi
-
Membuat API REST baru
- Di konsol Amazon API Gateway, pilih API di panel navigasi kiri.
- Pilih Bangun pada REST API.
- Di bagian Pilih protokol, pilih REST.
- Di bagian Buat API baru, pilih API Baru.
- Di bagian Pengaturan, masukkan WildRydes untuk Nama API dan pilih Edge yang dioptimalkan di menu tarik turun Tipe Titik Akhir.
Catatan: Gunakan tipe titik akhir yang dioptimalkan edge untuk layanan publik yang diakses dari Internet. Titik akhir wilayah biasanya digunakan untuk API yang diakses terutama dari dalam Wilayah AWS yang sama. - Pilih Buat API.
-
Buat otorisator
Anda harus membuat Otorisator Kolam Pengguna Amazon Cognito. Amazon API Gateway menggunakan token web JSON (JWT), yang dikembalikan oleh Kolam Pengguna Amazon Cognito (dibuat di Modul 2) untuk mengautentikasi panggilan API. Di bagian ini, kita akan membuat Pengotorisasi untuk API, sehingga kita dapat menggunakan kolam pengguna.
Gunakan langkah-langkah berikut untuk mengonfigurasi Pengotorisasi di konsol Amazon API Gateway:
- Di panel navigasi kiri WildRydes API yang baru saja Anda buat, pilih Pengotorisasi.
- Pilih Buat Pengotorisasi Baru.
- Masukkan WildRydes ke dalam kolom Nama Pengotorisasi.
- Pilih Cognito sebagai Tipe.
- Pada Kolam Pengguna Cognito, di menu tarik-turun Wilayah, pilih Wilayah yang sama yang telah Anda gunakan selama tutorial. Masukkan WildRydes di kolom nama Kolam Pengguna Cognito.
- Masukkan Pengotorisasi untuk Sumber Token.
- Pilih Buat.
- Untuk memverifikasi konfigurasi pengotorisasi, pilih Pengujian.
- Tempelkan Token Otorisasi yang disalin dari halaman web ride.html di bagian Validasikan implementasi Anda dari Modul 2 ke kolom Pengotorisasi (header), dan pastikan bahwa Kode respons status HTTP adalah 200.
-
Membuat sumber daya dan metode baru
Di bagian ini, Anda akan membuat sumber daya baru dalam API Anda. Kemudian, buat metode POST untuk sumber daya tersebut dan konfigurasikan untuk menggunakan integrasi proksi Lambda yang didukung oleh fungsi RequestUnicorn yang Anda buat dalam langkah pertama modul ini.
- Di panel navigasi kiri WildRydes API Anda, pilih Sumber daya.
- Dari menu traik-turun Tindakan, pilih Buat Sumber Daya.
- Masukkan ride sebagai Nama Sumber Daya, yang secara otomatis akan membuat Jalur Sumber Daya /ride.
- Pilih kotak centang untuk Aktifkan API Gateway CORS.
- Pilih Buat Sumber Daya.
- Dengan memilih sumber daya /ride yang baru dibuat, dari menu tarik-turun Tindakan, pilih Buat Metode.
- Pilih POST dari menu tarik-turun baru yang muncul di bawah OPTIONS, lalu pilih ikon tanda centang.
- Pilih Fungsi Lambda untuk Tipe integrasi.
- Pilih kotak centang untuk Gunakan integrasi Proxy Lambda.
- Pilih Wilayah yang sama yang telah Anda gunakan di seluruh tutorial untuk Wilayah Lambda.
- Masukkan RequestUnicorn untuk Fungsi Lambda.
- Pilih Simpan.
Catatan: jika Anda mendapatkan kesalahan bahwa fungsi Anda tidak ada, periksa apakah wilayah yang dipilih cocok dengan yang Anda gunakan di modul sebelumnya. - Ketika diminta untuk memberikan izin Amazon API Gateway untuk menginvokasi fungsi Anda, pilih OK.
- Pilih kartu Permintaan Metode.
- Pilih ikon pensil di sebelah Otorisasi.
- Pilih pengotorisasi kolam pengguna Cognito WildRydes dari menu tarik-turun, dan pilih ikon tanda centang.
-
Men-deploy API Anda
Di bagian ini, Anda akan men-deploy API Anda dari konsol Amazon API Gateway.
- Pada daftar tarik-turun Tindakan, pilih Deploy API.
- Pilih [Tahap Baru] di daftar tarik-turun Tahap deployment.
- Masukkan prod untuk Nama Tahap.
- Pilih Deploy.
- Salin URL Permintaan. Anda akan menggunakannya di bagian berikutnya.
-
Memperbarui konfigurasi situs web
Dalam langkah ini, Anda akan memperbarui file /js/config.js di deployment situs web Anda agar menyertakan URL Permintaan tahap yang baru saja dibuat. Anda akan menyalin URL Permintaan langsung dari atas halaman editor tahap di konsol Amazon API Gateway dan menempelkannya ke dalam kunci invokeUrl file config.js situs Anda. File konfigurasi Anda akan tetap berisi pembaruan yang Anda buat di modul sebelumnya untuk userPoolID, userPoolClientID, dan wilayah Amazon Cognito Anda.
- Pada mesin lokal Anda, navigasikan ke folder js, dan buka file config.js di editor teks pilihan Anda
- Tempelkan URL Permintaan yang Anda salin dari konsol Amazon API Gateway di bagian sebelumnya ke dalam nilai invokeUrl file config.js.
- Simpan file.
Lihat contoh berikut dari file config.js yang sudah selesai. Ingat, nilai sebenarnya dalam file Anda akan berbeda.
window._config = { cognito: { userPoolId: 'us-west-2_uXboG5pAb', // e.g. us-east-2_uXboG5pAb userPoolClientId: '25ddkmj4v6hfsfvruhpfi7n4hv', // e.g. 25ddkmj4v6hfsfvruhpfi7n4hv region: 'us-west-2' // e.g. us-east-2 }, api: { invokeUrl: 'https://rc7nyt4tql.execute-api.us-west-2.amazonaws.com/prod' // e.g. https://rc7nyt4tql.execute-api.us-west-2.amazonaws.com/prod, } };
3. Tambahkan, commit, dan dorong file config.js yang diperbarui ke repositori Git Anda agar secara otomatis di-deploy ke Konsol Amplify.
$ git add . $ git commit -m "new_configuration" $ git push
-
Memvalidasi implementasi Anda
Catatan: Anda mungkin akan melihat keterlambatan antara pembaruan file config.js di bucket S3 dan ketika konten yang diperbarui terlihat di peramban Anda. Anda juga harus memastikan bahwa Anda sudah membersihkan cache peramban sebelum melaksanakan langkah berikutnya.
- Perbarui versi ArcGIS JS dari 4.3 ke 4.6 (versi yang lebih baru tidak akan berfungsi dalam tutorial ini) di file ride.html sebagai:
<script src="https://js.arcgis.com/4.6/"></script> <link rel="stylesheet" href="https://js.arcgis.com/4.6/esri/css/main.css">
Contoh file config.js yang selesai disertakan di bawah ini. Catatan, beberapa nilai dalam file Anda mungkin berbeda.
<div id="noApiMessage" class="configMessage" style="display: none;"> <div class="backdrop"></div> <div class="panel panel-default"> <div class="panel-heading"> <h3 class="panel-title">Successfully Authenticated!</h3> </div> <div class="panel-body"> <p>This page is not functional yet because there is no API invoke URL configured in <a href="/js/config.js">/js/config.js</a>. You'll configure this in Module 3.</p> <p>In the meantime, if you'd like to test the Amazon Cognito user pool authorizer for your API, use the auth token below:</p> <textarea class="authToken"></textarea> </div> </div> </div> <div id="noCognitoMessage" class="configMessage" style="display: none;"> <div class="backdrop"></div> <div class="panel panel-default"> <div class="panel-heading"> <h3 class="panel-title">No Cognito User Pool Configured</h3> </div> <div class="panel-body"> <p>There is no user pool configured in <a href="/js/config.js">/js/config.js</a>. You'll configure this in Module 2 of the workshop.</p> </div> </div> </div> <div id="main"> <div id="map"> </div> </div> <div id="authTokenModal" class="modal fade" tabindex="-1" role="dialog" aria-labelledby="authToken"> <div class="modal-dialog" role="document"> <div class="modal-content"> <div class="modal-header"> <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button> <h4 class="modal-title" id="myModalLabel">Your Auth Token</h4> </div> <div class="modal-body"> <textarea class="authToken"></textarea> </div> <div class="modal-footer"> <button type="button" class="btn btn-default" data-dismiss="modal">Close</button> </div> </div> </div> </div> <script src="js/vendor/jquery-3.1.0.js"></script> <script src="js/vendor/bootstrap.min.js"></script> <script src="js/vendor/aws-cognito-sdk.min.js"></script> <script src="js/vendor/amazon-cognito-identity.min.js"></script> <script src="https://js.arcgis.com/4.6/"></script> <script src="js/config.js"></script> <script src="js/cognito-auth.js"></script> <script src="js/esri-map.js"></script> <script src="js/ride.js"></script> </body> </html>
2. Simpan file yang dimodifikasi. Tambahkan, commit, dan dorong git ke repositori Git agar di-deploy secara otomatis ke konsol AWS Amplify.
3. Kunjungi /ride.html di domain situs web Anda.
4. Jika Anda dialihkan ke halaman masuk ArcGIS, masuk dengan kredensial pengguna yang Anda buat sebelumnya di bagian Pendahuluansebagai prasyarat dari tutorial ini.
5. Setelah peta dimuat, klik di mana saja pada peta untuk mengatur lokasi pengambilan.
6. Pilih Permintaan Unicorn. Anda akan melihat notifikasi di bilah sisi kanan bahwa unicorn akan segera hadir, lalu Anda akan melihat ikon unicorn terbang ke lokasi pengambilan Anda.
- Perbarui versi ArcGIS JS dari 4.3 ke 4.6 (versi yang lebih baru tidak akan berfungsi dalam tutorial ini) di file ride.html sebagai: