Tutorial: Buat REST API dengan integrasi pribadi - Amazon API Gateway
Langkah 1: Buat layanan Amazon ECSLangkah 2: Buat tautan VPCLangkah 3: Buat REST APILangkah 4: Uji API AndaLangkah 5: Menerapkan API AndaLangkah 6: Hubungi API AndaLangkah 7: Bersihkan

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

Tutorial: Buat REST API dengan integrasi pribadi

Dalam tutorial ini, Anda membuat REST API yang terhubung ke layanan Amazon ECS yang berjalan di Amazon VPC. Klien di luar VPC Amazon Anda dapat menggunakan API untuk mengakses layanan Amazon ECS Anda.

Tutorial ini membutuhkan waktu sekitar satu jam untuk menyelesaikannya. Pertama, Anda menggunakan CloudFormation template untuk membuat Amazon VPC dan layanan Amazon ECS. Kemudian Anda menggunakan konsol API Gateway untuk membuat tautan VPC V2. Tautan VPC memungkinkan API Gateway untuk mengakses layanan Amazon ECS yang berjalan di VPC Amazon Anda. Selanjutnya, Anda membuat REST API yang menggunakan tautan VPC V2 untuk terhubung ke layanan Amazon ECS Anda. Terakhir, Anda menguji API Anda.

Saat Anda menjalankan REST API, API Gateway merutekan permintaan ke layanan Amazon ECS Anda melalui tautan VPC V2, lalu mengembalikan respons dari layanan.

catatan

Tutorial ini sebelumnya didukung untuk HTTP APIs, dan sekarang didukung untuk REST APIs menggunakan VPC link V2.

Ikhtisar REST API yang Anda buat dalam tutorial ini.

Untuk menyelesaikan tutorial ini, Anda memerlukan AWS akun dan AWS Identity and Access Management pengguna dengan akses konsol. Untuk informasi selengkapnya, lihat Siapkan untuk menggunakan API Gateway.

Langkah 1: Buat layanan Amazon ECS

Amazon ECS adalah layanan manajemen kontainer yang memudahkan untuk menjalankan, menghentikan, dan mengelola kontainer Docker di cluster. Dalam tutorial ini, Anda menjalankan cluster Anda pada infrastruktur tanpa server yang dikelola oleh Amazon ECS.

Unduh dan unzip CloudFormation template ini, yang membuat semua dependensi untuk layanan, termasuk VPC Amazon. Anda menggunakan template untuk membuat layanan Amazon ECS yang menggunakan Application Load Balancer.

Untuk membuat CloudFormation tumpukan

  1. Buka CloudFormation konsol di https://console.aws.amazon.com/cloudformation.

  2. Pilih Buat tumpukan kemudian pilih Dengan sumber daya baru (standar).

  3. Untuk Tentukan templat, pilih Unggah file templat.

  4. Pilih template yang Anda unduh.

  5. Pilih Berikutnya.

  6. Untuk nama Stack, masukkan rest-api-private-integrations-tutorial dan kemudian pilih Berikutnya.

  7. Untuk opsi Konfigurasi tumpukan, pilih Berikutnya.

  8. Untuk Kemampuan, akui bahwa CloudFormation dapat membuat sumber daya IAM di akun Anda.

  9. Pilih Berikutnya, lalu pilih Kirim.

CloudFormation menyediakan layanan ECS, yang dapat memakan waktu beberapa menit. Ketika status CloudFormation tumpukan Anda adalah CREATE_COMPLETE, Anda siap untuk melanjutkan ke langkah berikutnya.

Tautan VPC memungkinkan API Gateway untuk mengakses sumber daya pribadi di VPC Amazon. Anda menggunakan tautan VPC untuk memungkinkan klien mengakses layanan Amazon ECS Anda melalui REST API Anda.

Untuk membuat tautan VPC

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

  2. Pada panel navigasi utama, pilih tautan VPC dan kemudian pilih Buat.

    Anda mungkin perlu memilih ikon menu untuk membuka panel navigasi utama.

  3. Untuk Pilih versi tautan VPC, pilih tautan VPC V2.

  4. Untuk Nama, masukkan private-integrations-tutorial.

  5. Untuk VPC, pilih VPC yang Anda buat di langkah 1. Nama harus dimulai dengan RestApiStack.

  6. Untuk Subnet, pilih dua subnet pribadi di VPC Anda. Nama mereka diakhiri dengan PrivateSubnet

  7. Untuk grup Keamanan, pilih ID Grup yang dimulai dengan private-integrations-tutorial dan memiliki deskripsiRestApiStack/RestApiTutorialService/Service/SecurityGroup.

  8. Pilih Buat.

Setelah Anda membuat tautan VPC V2, API Gateway menyediakan Antarmuka Jaringan Elastis untuk mengakses VPC Anda. Prosesnya bisa memakan waktu beberapa menit. Sementara itu, Anda dapat membuat API Anda.

Langkah 3: Buat REST API

REST API menyediakan titik akhir HTTP untuk layanan Amazon ECS Anda.

Untuk membuat REST API

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

  2. Pilih Create API, lalu untuk REST API, pilih Build.

  3. Untuk Nama, masukkan private-integration-api.

  4. Untuk jenis alamat IP, pilih IPv4.

  5. Pilih Buat API.

    Setelah membuat API, Anda membuat metode.

  6. Pilih metode Create, dan kemudian lakukan hal berikut:

    1. Untuk jenis Metode, pilihGET.

    2. Untuk jenis Integrasi, pilih tautan VPC.

    3. Aktifkan integrasi proxy VPC.

    4. Untuk metode HTTP, pilihGET.

    5. Untuk tautan VPC, pilih tautan VPC V2 yang Anda buat di langkah sebelumnya.

    6. Untuk target Integrasi, masukkan penyeimbang beban yang Anda buat dengan CloudFormation template di Langkah 1. Namanya harus dimulai dengan istirahat-.

    7. Untuk URL Endpoint, masukkanhttp://private-integrations-tutorial.com.

      URL digunakan untuk mengatur Host header permintaan integrasi. Dalam hal ini, header host adalahprivate-integrations-tutorial.

    8. Pilih metode Buat.

      Dengan integrasi proxy, API siap untuk diuji.

Langkah 4: Uji API Anda

Selanjutnya, Anda menguji pemanggilan metode API.

Untuk menguji API Anda

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

  2. Pilih API Anda.

  3. Pilih tab Uji. Anda mungkin perlu memilih tombol panah kanan untuk menampilkan tab.

  4. Pilih Tes

    Verifikasi bahwa respons API Anda adalah pesan selamat datang yang memberi tahu Anda bahwa aplikasi Anda berjalan di Amazon ECS.

Langkah 5: Menerapkan API Anda

Selanjutnya, Anda menerapkan 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.

Langkah 6: Hubungi API Anda

Setelah API Anda di-deploy, Anda dapat memanggilnya.

Untuk memanggil API Anda

  1. Masukkan URL pemanggilan di browser web.

    URL lengkap akan terlihat sepertihttps://abcd123.execute-api.us-east-2.amazonaws.com/Prod.

    Browser Anda mengirimkan GET permintaan ke API.

  2. Verifikasi bahwa respons API Anda adalah pesan selamat datang yang memberi tahu Anda bahwa aplikasi Anda berjalan di Amazon ECS.

    Jika Anda melihat pesan selamat datang, Anda berhasil membuat layanan Amazon ECS yang berjalan di VPC Amazon, dan Anda menggunakan API REST API Gateway API dengan tautan VPC V2 untuk mengakses layanan Amazon ECS.

Langkah 7: Bersihkan

Untuk mencegah biaya yang tidak perlu, hapus sumber daya yang Anda buat sebagai bagian dari tutorial ini. Langkah-langkah berikut menghapus tautan VPC V2, CloudFormation stack, dan REST API Anda.

Untuk menghapus REST API

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

  2. Pada APIshalaman, pilih API. Pilih Tindakan, pilih Hapus, lalu konfirmasikan pilihan Anda.

Untuk menghapus tautan VPC

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

  2. Pilih tautan VPC.

  3. Pilih tautan VPC Anda, pilih Hapus, lalu konfirmasikan pilihan Anda.

Untuk menghapus CloudFormation tumpukan

  1. Buka CloudFormation konsol di https://console.aws.amazon.com/cloudformation.

  2. Pilih CloudFormation tumpukan Anda.

  3. Pilih Hapus dan kemudian konfirmasikan pilihan Anda.