Tutorial: Membuat REST API dengan integrasi proxy HTTP - Amazon API Gateway
Membuat API dengan integrasi proxy HTTP menggunakan konsol API GatewayUji API dengan integrasi proxy HTTP

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

Tutorial: Membuat REST API dengan integrasi proxy HTTP

Integrasi proxy HTTP adalah mekanisme sederhana, kuat, dan serbaguna untuk membangun API yang memungkinkan aplikasi web mengakses beberapa sumber daya atau fitur dari titik akhir HTTP terintegrasi, misalnya seluruh situs web, dengan pengaturan yang efisien dari satu metode API. Dalam integrasi proxy HTTP, API Gateway meneruskan permintaan metode yang dikirimkan klien ke backend. Data permintaan yang diteruskan mencakup header permintaan, parameter string kueri, variabel jalur URL, dan payload. Titik akhir HTTP backend atau server web mem-parsing data permintaan yang masuk untuk menentukan respons yang dikembalikan. Integrasi proxy HTTP membuat klien dan backend berinteraksi secara langsung tanpa intervensi dari API Gateway setelah metode API disiapkan, kecuali untuk masalah yang diketahui seperti karakter yang tidak didukung, yang tercantum di dalamnya. Catatan penting Amazon API Gateway

Dengan sumber daya proxy yang mencakup semua{proxy+}, dan ANY kata kerja catch-all untuk metode HTTP, Anda dapat menggunakan integrasi proxy HTTP untuk membuat API dari satu metode API. Metode ini mengekspos seluruh rangkaian sumber daya HTTP yang dapat diakses publik dan operasi situs web. Ketika server web backend membuka lebih banyak sumber daya untuk akses publik, klien dapat menggunakan sumber daya baru ini dengan penyiapan API yang sama. Untuk mengaktifkan ini, pengembang situs web harus mengkomunikasikan dengan jelas kepada pengembang klien apa sumber daya baru dan operasi apa yang berlaku untuk masing-masing sumber daya tersebut.

Sebagai pengantar singkat, tutorial berikut menunjukkan integrasi proxy HTTP. Dalam tutorial, kita membuat API menggunakan konsol API Gateway untuk berintegrasi dengan PetStore situs web melalui sumber daya proxy generik{proxy+}, dan membuat placeholder metode HTTP dari. ANY

Membuat API dengan integrasi proxy HTTP menggunakan konsol API Gateway

Prosedur berikut memandu Anda melalui langkah-langkah untuk membuat dan menguji API dengan sumber daya proxy untuk backend HTTP menggunakan konsol API Gateway. Backend HTTP adalah PetStore situs web (http://petstore-demo-endpoint.execute-api.com/petstore/pets) dariTutorial: Buat REST API dengan integrasi HTTP non-proxy, di mana tangkapan layar digunakan sebagai alat bantu visual untuk mengilustrasikan elemen UI API Gateway. Jika Anda baru menggunakan konsol API Gateway untuk membuat API, Anda mungkin ingin mengikuti bagian itu terlebih dahulu.

Untuk membuat API

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

  2. Jika ini adalah pertama kalinya Anda menggunakan API Gateway, Anda akan melihat halaman yang memperkenalkan Anda ke fitur layanan. Di bawah REST API, pilih Build. Saat munculan Create Example API muncul, pilih OK.

    Jika ini bukan pertama kalinya Anda menggunakan API Gateway, pilih Buat API. Di bawah REST API, pilih Build.

  3. Untuk nama API, masukkanHTTPProxyAPI.

  4. (Opsional) Untuk Deskripsi, masukkan deskripsi.

  5. Tetap tetapkan jenis endpoint API ke Regional.

  6. Pilih Buat API.

Pada langkah ini, Anda membuat jalur sumber daya proxy dari{proxy+}. Ini adalah placeholder dari salah satu titik akhir backend di bawah. http://petstore-demo-endpoint.execute-api.com/ Misalnya, bisa jadipetstore,petstore/pets, danpetstore/pets/{petId}. API Gateway membuat ANY metode saat Anda membuat {proxy+} sumber daya dan berfungsi sebagai placeholder untuk salah satu kata kerja HTTP yang didukung pada waktu berjalan.

Untuk membuat sumber daya/{proxy+}

  1. Pilih API Anda.

  2. Di panel navigasi utama, pilih Resources.

  3. Pilih Buat sumber daya.

  4. Aktifkan sumber daya proxy.

  5. Pertahankan jalur Sumber Daya sebagai/.

  6. Untuk Nama sumber daya, masukkan {proxy+}.

  7. Tetap nonaktifkan CORS (Cross Origin Resource Sharing).

  8. Pilih Buat sumber daya.

    Buat sumber daya anak.

Pada langkah ini, Anda mengintegrasikan ANY metode dengan titik akhir HTTP backend, menggunakan integrasi proxy. Dalam integrasi proxy, API Gateway meneruskan permintaan metode yang dikirimkan klien ke backend tanpa intervensi dari API Gateway.

Untuk membuat ANY metode

  1. Pilih sumber daya/{proxy+}.

  2. Pilih metode APAPUN.

  3. Di bawah simbol peringatan, pilih Edit integrasi. Anda tidak dapat menerapkan API yang memiliki metode tanpa integrasi.

  4. Untuk jenis Integrasi, pilih HTTP.

  5. Aktifkan integrasi proxy HTTP.

  6. Untuk metode HTTP, pilih APAPUN.

  7. Untuk URL Endpoint, masukkanhttp://petstore-demo-endpoint.execute-api.com/{proxy}.

  8. Pilih Simpan.

Uji API dengan integrasi proxy HTTP

Apakah permintaan klien tertentu berhasil tergantung pada hal berikut:

  • Jika backend telah membuat titik akhir backend yang sesuai tersedia dan, jika demikian, telah memberikan izin akses yang diperlukan.

  • Jika klien memberikan masukan yang benar.

Misalnya, PetStore API yang digunakan di sini tidak mengekspos /petstore sumber daya. Dengan demikian, Anda mendapatkan 404 Resource Not Found respons yang berisi pesan kesalahanCannot GET /petstore.

Selain itu, klien harus dapat menangani format output backend untuk mengurai hasil dengan benar. API Gateway tidak memediasi untuk memfasilitasi interaksi antara klien dan backend.

Untuk menguji API yang terintegrasi dengan PetStore situs web menggunakan integrasi proxy HTTP melalui sumber daya proxy

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

  2. Untuk jenis Metode, pilihGET.

  3. Untuk Path, di bawah proxy, masukkanpetstore/pets.

  4. Untuk string Query, masukkantype=fish.

  5. Pilih Uji.

    Gunakan fitur uji untuk menguji metode.

    Karena situs web backend mendukung GET /petstore/pets?type=fish permintaan, ia mengembalikan respons yang berhasil serupa dengan yang berikut ini:

    [
  {
    "id": 1,
    "type": "fish",
    "price": 249.99
  },
  {
    "id": 2,
    "type": "fish",
    "price": 124.99
  },
  {
    "id": 3,
    "type": "fish",
    "price": 0.99
  }
]

    Jika Anda mencoba meneleponGET /petstore, Anda mendapatkan 404 respons dengan pesan kesalahanCannot GET /petstore. Ini karena backend tidak mendukung operasi yang ditentukan. Jika Anda meneleponGET /petstore/pets/1, Anda mendapatkan 200 OK respons dengan muatan berikut, karena permintaan tersebut didukung oleh PetStore situs web.

    {
  "id": 1,
  "type": "dog",
  "price": 249.99
}

Anda juga dapat menggunakan browser untuk menguji API Anda. Terapkan API Anda dan kaitkan ke panggung untuk membuat URL Invoke API Anda.

Untuk men-deploy API Anda

  1. Pilih Deploy API.

  2. Untuk Stage, pilih New stage.

  3. Untuk nama Panggung, masukkantest.

  4. (Opsional) Untuk Deskripsi, masukkan deskripsi.

  5. Pilih Deploy.

Sekarang klien dapat menghubungi API Anda.

Untuk menjalankan API Anda

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

  2. Pilih API Anda.

  3. Di panel navigasi utama, pilih Stage.

  4. Di bawah Detail tahap, pilih ikon salin untuk menyalin URL pemanggilan API Anda.

    Masukkan URL pemanggilan API Anda di browser web.

    URL lengkap akan terlihat sepertihttps://abcdef123.execute-api.us-east-2.amazonaws.com/test/petstore/pets?type=fish.

    Browser Anda mengirimkan GET permintaan ke API.

  5. Hasilnya harus sama dengan yang dikembalikan saat Anda menggunakan Test di konsol API Gateway.