Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Pengantar pengujian dengan start-api lokal sam
Gunakan AWS Serverless Application Model Antarmuka Baris Perintah (AWS SAM CLI) sam local start-api subperintah untuk menjalankan Anda AWS Lambda Fungsi Event secara lokal dan uji melalui host server HTTP lokal. Jenis pengujian ini berguna untuk fungsi Lambda yang dipanggil oleh titik akhir Amazon API Gateway.
-
Untuk pengantar AWS SAM CLI, lihat Apa itu AWS SAM CLI?
-
Untuk daftar
sam local start-apiopsi perintah, lihat start-api lokal sam. -
Sebagai contoh penggunaan
sam local start-apiselama alur kerja pengembangan yang khas, lihat Langkah 7: (Opsional) Uji aplikasi Anda secara lokal.
Server HTTP lokal menjalankan kode fungsi Anda di mesin Anda, dengan akses ke lingkungan lokal Anda. Uji kode yang tidak Anda buat di layanan Lambda, yang diisolasi dari mesin Anda.
sam local start-api mendukung fungsi tahan lama dengan kemampuan checkpointing dan replay otomatis. Fungsi tahan lama bekerja dengan lancar dengan titik akhir Gateway API lokal.
Untuk menggunakan sam local start-api, instal AWS SAM CLI dengan menyelesaikan yang berikut ini:
Sebelum menggunakan sam local start-api, kami merekomendasikan pemahaman dasar tentang hal-hal berikut:
Menggunakan sam local start-api
Saat Anda berlari sam local start-api, AWS SAM CLI mengasumsikan bahwa direktori kerja Anda saat ini adalah direktori root proyek Anda. The AWS SAM CLI pertama-tama akan mencari template.[yaml|yml] berkas dalam sebuah .aws-sam subfolder. Jika tidak ditemukan, AWS SAM CLI akan mencari template.[yaml|yml] file dalam direktori kerja Anda saat ini.
Untuk memulai server HTTP lokal
-
Dari direktori root proyek Anda, jalankan yang berikut ini:
$sam local start-api<options> -
The AWS SAM CLI membangun fungsi Lambda Anda di lokal Docker wadah. Kemudian menampilkan alamat lokal dari titik akhir server HTTP Anda. Berikut ini adalah contohnya:
$sam local start-apiInitializing the lambda functions containers. Local image is up-to-date Using local image: public.ecr.aws/lambda/python:3.9-rapid-x86_64. Mounting /Users/.../sam-app/.aws-sam/build/HelloWorldFunction as /var/task:ro,delegated, inside runtime container Containers Initialization is done. Mounting HelloWorldFunction at http://127.0.0.1:3000/hello [GET] You can now browse to the above endpoints to invoke your functions. You do not need to restart/reload SAM CLI while working on your functions, changes will be reflected instantly/automatically. If you used sam build before running local commands, you will need to re-run sam build for the changes to be picked up. You only need to restart SAM CLI if you update your AWS SAM template 2023-04-12 14:41:05 WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead. * Running on http://127.0.0.1:3000 -
Anda dapat memanggil fungsi Lambda Anda melalui browser atau command prompt. Berikut ini adalah contohnya:
sam-app$curl http://127.0.0.1:3000/hello{"message": "Hello world!"}% -
Saat Anda membuat perubahan pada kode fungsi Lambda, pertimbangkan hal berikut untuk menyegarkan server HTTP lokal Anda:
-
Jika aplikasi Anda tidak memiliki
.aws-samdirektori dan fungsi Anda menggunakan bahasa yang ditafsirkan, AWS SAM CLI akan secara otomatis memperbarui fungsi Anda dengan membuat wadah baru dan meng-hostingnya. -
Jika aplikasi Anda memiliki
.aws-samdirektori, Anda perlu menjalankansam builduntuk memperbarui fungsi Anda. Lalu jalankansam local start-apisekali lagi untuk meng-host fungsi. -
Jika fungsi Anda menggunakan bahasa yang dikompilasi atau jika proyek Anda memerlukan dukungan pengemasan yang kompleks, jalankan solusi build Anda sendiri untuk memperbarui fungsi Anda. Lalu jalankan
sam local start-apisekali lagi untuk meng-host fungsi.
-
Fungsi Peristiwa Lambda yang menggunakan otorisasi Lambda
Fitur ini baru di AWS SAM CLI versi 1.80.0. Untuk meningkatkan, lihat Upgrade AWS SAMCLI.
Untuk fungsi Lambda yang menggunakan otorisasi Lambda, AWS SAM CLI akan secara otomatis memanggil otorizer Lambda Anda sebelum memanggil titik akhir fungsi Lambda Anda.
Berikut ini adalah contoh memulai server HTTP lokal untuk fungsi yang menggunakan otorizer Lambda:
$sam local start-api2023-04-17 15:02:13 Attaching import module proxy for analyzing dynamic imports AWS SAM CLI does not guarantee 100% fidelity between authorizers locally and authorizers deployed on AWS. Any application critical behavior should be validated thoroughly before deploying to production. Testing application behaviour against authorizers deployed on AWS can be done using the sam sync command. Mounting HelloWorldFunction at http://127.0.0.1:3000/authorized-request [GET] You can now browse to the above endpoints to invoke your functions. You do not need to restart/reload SAM CLI while working on your functions, changes will be reflected instantly/automatically. If you used sam build before running local commands, you will need to re-run sam build for the changes to be picked up. You only need to restart SAM CLI if you update your AWS SAM template 2023-04-17 15:02:13 WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead. * Running on http://127.0.0.1:3000 2023-04-17 15:02:13 Press CTRL+C to quit
Ketika Anda memanggil titik akhir fungsi Lambda Anda melalui server HTTP lokal, AWS SAM CLI pertama memanggil otorisasi Lambda Anda. Jika otorisasi berhasil, AWS SAM CLI akan memanggil titik akhir fungsi Lambda Anda. Berikut ini adalah contohnya:
$curl http://127.0.0.1:3000/authorized-request --header "header:my_token"{"message": "from authorizer"}% Invoking app.authorizer_handler (python3.8) Local image is up-to-date Using local image: public.ecr.aws/lambda/python:3.8-rapid-x86_64. Mounting /Users/.../sam-app/... as /var/task:ro,delegated, inside runtime container START RequestId: 38d3b472-a2c8-4ea6-9a77-9b386989bef0 Version: $LATEST END RequestId: 38d3b472-a2c8-4ea6-9a77-9b386989bef0 REPORT RequestId: 38d3b472-a2c8-4ea6-9a77-9b386989bef0 Init Duration: 1.08 ms Duration: 628.26 msBilled Duration: 629 ms Memory Size: 128 MB Max Memory Used: 128 MB Invoking app.request_handler (python3.8) Using local image: public.ecr.aws/lambda/python:3.8-rapid-x86_64. Mounting /Users/.../sam-app/... as /var/task:ro,delegated, inside runtime container START RequestId: fdc12255-79a3-4365-97e9-9459d06446ff Version: $LATEST END RequestId: fdc12255-79a3-4365-97e9-9459d06446ff REPORT RequestId: fdc12255-79a3-4365-97e9-9459d06446ff Init Duration: 0.95 ms Duration: 659.13 msBilled Duration: 660 ms Memory Size: 128 MB Max Memory Used: 128 MB No Content-Type given. Defaulting to 'application/json'. 2023-04-17 15:03:03 127.0.0.1 - - [17/Apr/2023 15:03:03] "GET /authorized-request HTTP/1.1" 200 -
Opsi
Terus gunakan kembali wadah untuk mempercepat pemanggilan fungsi lokal
Secara default, AWS SAM CLI membuat wadah baru setiap kali fungsi Anda dipanggil melalui server HTTP lokal. Gunakan --warm-containers opsi untuk secara otomatis menggunakan kembali wadah Anda untuk pemanggilan fungsi. Ini mempercepat waktu yang dibutuhkan untuk AWS SAM CLI untuk mempersiapkan fungsi Lambda Anda untuk pemanggilan lokal. Anda dapat menyesuaikan opsi ini lebih lanjut dengan menyediakan eager atau lazy argumen.
-
eager— Wadah untuk semua fungsi dimuat saat startup dan bertahan di antara pemanggilan. -
lazy— Kontainer hanya dimuat ketika setiap fungsi pertama kali dipanggil. Mereka kemudian bertahan untuk permohonan tambahan.
Berikut ini adalah contohnya:
$sam local start-api --warm-containers eager
Saat menggunakan --warm-containers dan memodifikasi kode fungsi Lambda Anda:
-
Jika aplikasi Anda memiliki
.aws-samdirektori, jalankansam builduntuk memperbarui kode fungsi Anda di artefak build aplikasi Anda. -
Ketika perubahan kode terdeteksi, AWS SAM CLI secara otomatis mematikan wadah fungsi Lambda.
-
Ketika Anda memanggil fungsi lagi, AWS SAM CLI secara otomatis membuat wadah baru.
Jika menonton file menyebabkan CPU tinggi atau I/O Overhead—misalnya, di monorepo besar, lingkungan dengan perangkat lunak antivirus, atau proyek di mana beberapa fungsi berbagi CodeUri—Anda dapat menonaktifkannya dengan --no-watch pilihan:
$sam local start-api --warm-containers eager --no-watch
Dengan --no-watch, perubahan kode dan template tidak terdeteksi secara otomatis. Hentikan dan jalankan kembali perintah untuk mengambil perubahan.
Tentukan gambar kontainer yang akan digunakan untuk Lambda Event Functions
Secara default, AWS SAM CLI menggunakan gambar dasar Lambda dari Amazon Elastic Container Registry (Amazon ECR) untuk memanggil fungsi Anda secara lokal. Gunakan --invoke-image opsi untuk mereferensikan gambar wadah khusus. Berikut ini adalah contohnya:
$sam local start-api --invoke-imagepublic.ecr.aws/sam/emu-python3.8
Anda dapat menentukan fungsi yang akan digunakan dengan gambar wadah khusus. Berikut ini adalah contohnya:
$sam local start-api --invoke-imageFunction1=amazon/aws/sam-cli-emulation-image-python3.8
Tentukan template untuk diuji secara lokal
Untuk menentukan template untuk AWS SAM CLI Untuk referensi, gunakan --template pilihan. Yang AWS SAM CLI akan memuat hanya itu AWS SAM template dan sumber daya yang ditunjuk. Berikut ini adalah contohnya:
$sam local start-api --templatemyTemplate.yaml
Tentukan lingkungan pengembangan host dari Lambda Event Function Anda
Secara default, sam local start-api subcommand membuat server HTTP menggunakan localhost dengan alamat IP 127.0.0.1. Anda dapat menyesuaikan nilai-nilai ini jika lingkungan pengembangan lokal Anda terisolasi dari mesin lokal Anda.
Gunakan --container-host pilihan untuk menentukan host. Berikut ini adalah contohnya:
$sam local start-api --container-hosthost.docker.internal
Gunakan --container-host-interface opsi untuk menentukan alamat IP jaringan host yang harus diikat oleh port kontainer. Berikut ini adalah contohnya:
$sam local start-api --container-host-interface0.0.0.0
Praktik Terbaik
Jika aplikasi Anda memiliki .aws-sam direktori dari berjalan sam build, pastikan untuk berlari sam build setiap kali Anda memperbarui kode fungsi Anda. Lalu, jalankan sam local start-api untuk menguji kode fungsi Anda yang diperbarui secara lokal.
Pengujian lokal adalah solusi hebat untuk pengembangan dan pengujian cepat sebelum menerapkan ke cloud. Namun, pengujian lokal tidak memvalidasi semuanya, seperti izin antara sumber daya Anda di cloud. Sebisa mungkin, uji aplikasi Anda di cloud. Kami merekomendasikan memakai sam sync untuk mempercepat alur kerja pengujian cloud Anda.
Pelajari selengkapnya
Untuk daftar semua sam local start-api opsi, lihat start-api lokal sam.