Tutorial: Buat REST API dengan integrasi HTTP non-proxy - APIGerbang Amazon

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 HTTP non-proxy

Dalam tutorial ini, Anda membuat API dari awal menggunakan konsol Amazon API Gateway. Anda dapat menganggap konsol sebagai studio API desain dan menggunakannya untuk cakupan API fitur, untuk bereksperimen dengan perilakunya, untuk membangunAPI, dan untuk menyebarkan Anda API secara bertahap.

Buat API dengan integrasi HTTP khusus

Bagian ini memandu Anda melalui langkah-langkah untuk membuat sumber daya, mengekspos metode pada sumber daya, mengonfigurasi metode untuk mencapai API perilaku yang diinginkan, dan untuk menguji dan menerapkan. API

Pada langkah ini, Anda membuat kosongAPI. Dalam langkah-langkah berikut, Anda membuat sumber daya dan metode untuk menghubungkan Anda API ke http://petstore-demo-endpoint.execute-api.com/petstore/pets titik akhir, menggunakan integrasi non-proxyHTTP.

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 melihat halaman yang memperkenalkan Anda ke fitur layanan. Di bawah RESTAPI, pilih Build. Ketika API popup Create Example muncul, pilih OK.

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

  3. Untuk APInama, masukkanHTTPNonProxyAPI.

  4. (Opsional) Untuk Deskripsi, masukkan deskripsi.

  5. Pertahankan jenis API titik akhir disetel ke Regional.

  6. Pilih Buat API.

Pohon Resources menunjukkan sumber daya root (/) tanpa metode apa pun. Dalam latihan ini, kami akan membangun API dengan integrasi HTTP kustom PetStore situs web (http://petstore-demo-endpoint.execute-api. com/petstore/pets.) Untuk tujuan ilustrasi, kami akan membuat /pets sumber daya sebagai anak dari root dan mengekspos GET metode pada sumber daya ini bagi klien untuk mengambil daftar item Hewan Peliharaan yang tersedia dari situs web. PetStore

Untuk membuat sumber daya /pets
  1. Pilih Buat sumber daya.

  2. Matikan sumber daya Proxy.

  3. Pertahankan jalur Sumber Daya sebagai/.

  4. Untuk Nama sumber daya, masukkan pets.

  5. Keep CORS(Cross Origin Resource Sharing) dimatikan.

  6. Pilih Buat sumber daya.

Pada langkah ini, Anda membuat GET metode pada sumber daya /pets. GETMetode ini terintegrasi dengan situs http://petstore-demo-endpoint.execute-api.com/petstore/pets web. Opsi lain untuk suatu API metode termasuk yang berikut:

  • POST, terutama digunakan untuk membuat sumber daya anak.

  • PUT, terutama digunakan untuk memperbarui sumber daya yang ada (dan, meskipun tidak disarankan, dapat digunakan untuk membuat sumber daya anak).

  • DELETE, digunakan untuk menghapus sumber daya.

  • PATCH, digunakan untuk memperbarui sumber daya.

  • HEAD, terutama digunakan dalam skenario pengujian. Ini sama dengan GET tetapi tidak mengembalikan representasi sumber daya.

  • OPTIONS, yang dapat digunakan oleh penelepon untuk mendapatkan informasi tentang opsi komunikasi yang tersedia untuk layanan target.

Untuk HTTPmetode permintaan integrasi, Anda harus memilih salah satu yang didukung oleh backend. Untuk HTTP atauMock integration, masuk akal bahwa permintaan metode dan permintaan integrasi menggunakan HTTP kata kerja yang sama. Untuk jenis integrasi lainnya, permintaan metode kemungkinan akan menggunakan HTTP kata kerja yang berbeda dari permintaan integrasi. Misalnya, untuk memanggil fungsi Lambda, permintaan integrasi harus digunakan POST untuk memanggil fungsi, sedangkan permintaan metode dapat menggunakan HTTP kata kerja apa pun tergantung pada logika fungsi Lambda.

Untuk membuat GET metode pada sumber daya /pets
  1. Pilih sumber daya /pets.

  2. Pilih metode Buat.

  3. Untuk jenis Metode, pilih GET.

  4. Untuk jenis Integrasi, pilih HTTPintegrasi.

  5. Tetap nonaktifkan integrasi HTTP proxy.

  6. Untuk HTTPmetode, pilih GET.

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

    PetStore Situs web ini memungkinkan Anda untuk mengambil daftar Pet item berdasarkan jenis hewan peliharaan, seperti “Dog” atau “Cat”, pada halaman tertentu.

  8. Untuk penanganan Konten, pilih Passthrough.

  9. Pilih parameter string URL kueri.

    Situs PetStore web menggunakan parameter string type dan page kueri untuk menerima input. Anda menambahkan parameter string kueri ke permintaan metode dan memetakannya ke parameter string kueri yang sesuai dari permintaan integrasi.

  10. Untuk menambahkan parameter string kueri, lakukan hal berikut:

    1. Pilih Tambahkan string kueri.

    2. Untuk Nama, masukkan type

    3. Tetap Diperlukan dan Caching dimatikan.

    Ulangi langkah sebelumnya untuk membuat string kueri tambahan dengan namapage.

  11. Pilih metode Buat.

Klien sekarang dapat menyediakan jenis hewan peliharaan dan nomor halaman sebagai parameter string kueri saat mengirimkan permintaan. Parameter input ini harus dipetakan ke dalam parameter string kueri integrasi untuk meneruskan nilai input ke PetStore situs web kami di backend.

Untuk memetakan parameter input ke permintaan Integrasi
  1. Pada tab Permintaan integrasi, di bawah Pengaturan permintaan integrasi, pilih Edit.

  2. Pilih parameter string URL kueri, dan kemudian lakukan hal berikut:

    1. Pilih Tambahkan parameter string kueri.

    2. Untuk Nama, masukkan type.

    3. Untuk Dipetakan dari, masukkan method.request.querystring.type

    4. Tetap caching dimatikan.

    5. Pilih Tambahkan parameter string kueri.

    6. Untuk Nama, masukkan page.

    7. Untuk Dipetakan dari, masukkan method.request.querystring.page

    8. Tetap caching dimatikan.

  3. Pilih Simpan.

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

  2. Untuk string Query, masukkantype=Dog&page=2.

  3. Pilih Uji.

    Hasilnya mirip dengan yang berikut:

    Test-invoke GET pada hasil metode hewan peliharaan

    Sekarang setelah tes berhasil, kami dapat menggunakan API untuk membuatnya tersedia untuk umum.

  4. Pilih DeployAPI.

  5. Untuk Stage, pilih New stage.

  6. Untuk nama Panggung, masukkanProd.

  7. (Opsional) Untuk Deskripsi, masukkan deskripsi.

  8. Pilih Deploy.

  9. (Opsional) Di bawah detail Tahap, untuk Invoke URL, Anda dapat memilih ikon salin untuk menyalin panggilan AndaAPI. URL Anda dapat menggunakan ini dengan alat-alat seperti Postman dan c URL untuk menguji AndaAPI.

Jika Anda menggunakan SDK untuk membuat klien, Anda dapat memanggil metode yang diekspos oleh SDK untuk menandatangani permintaan. Untuk detail implementasi, lihat AWS SDKpilihan Anda.

catatan

Ketika perubahan dilakukan pada AndaAPI, Anda harus menerapkan ulang API untuk membuat fitur baru atau yang diperbarui tersedia sebelum memanggil permintaan lagi. URL

(Opsional) Parameter permintaan peta

Parameter permintaan peta untuk API Gateway API

Tutorial ini menunjukkan cara membuat parameter path {petId} pada API permintaan metode ini untuk menentukan ID item, memetakannya ke parameter {id} path dalam permintaan integrasiURL, dan mengirim permintaan ke HTTP titik akhir.

catatan

Jika Anda memasukkan huruf yang salah, seperti huruf kecil, bukan huruf besar, ini akan menyebabkan kesalahan nanti dalam penelusuran.

Langkah 1: Buat sumber daya

Pada langkah ini, Anda membuat sumber daya dengan parameter jalur {petId}.

Untuk membuat sumber daya {petId}
  1. Pilih sumber daya /pets, lalu pilih Create resource.

  2. Matikan sumber daya Proxy.

  3. Untuk jalur Sumber Daya, pilih /pets/.

  4. Untuk Nama sumber daya, masukkan {petId}.

    Gunakan kurawal kurawal ({ }) di sekitar petId sehingga /pets/ {} ditampilkan. petId

  5. Keep CORS(Cross Origin Resource Sharing) dimatikan.

  6. Pilih Buat sumber daya.

Langkah 2: Buat dan uji metode

Pada langkah ini, Anda membuat GET metode dengan parameter {petId} jalur.

Untuk mengatur GET metode
  1. Pilih sumber daya/{petId}, lalu pilih Create method.

  2. Untuk jenis Metode, pilih GET.

  3. Untuk jenis Integrasi, pilih HTTPintegrasi.

  4. Tetap nonaktifkan integrasi HTTP proxy.

  5. Untuk HTTPmetode, pilih GET.

  6. Untuk Endpoint URL, masukkan http://petstore-demo-endpoint.execute-api.com/petstore/pets/{id}

  7. Untuk penanganan Konten, pilih Passthrough.

  8. Tetap aktifkan batas waktu default.

  9. Pilih metode Buat.

Sekarang Anda memetakan parameter {petId} jalur yang baru saja Anda buat ke parameter {id} jalur di HTTP titik URL akhir permintaan integrasi. HTTPTitik akhir URL adalahhttp://petstore-demo-endpoint.execute-api.com/petstore/pets/{id}.

Untuk memetakan parameter {petId} jalur
  1. Pada tab Permintaan integrasi, di bawah Pengaturan permintaan integrasi, pilih Edit.

  2. Pilih parameter URL jalur.

  3. APIGateway membuat parameter jalur untuk permintaan integrasi bernama petId, namun parameter jalur ini tidak valid untuk HTTP titik akhir URL yang Anda tetapkan sebagai integrasi backend. HTTPTitik akhir digunakan {id} sebagai parameter jalur. Untuk Nama, hapus petIddan masukkanid.

    Ini memetakan parameter jalur permintaan metode petId ke parameter jalur permintaan integrasiid.

  4. Pilih Simpan.

Sekarang Anda menguji metodenya.

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

  2. Di bawah Jalan untuk petId, masuk4.

  3. Pilih Uji.

    Jika berhasil, badan Response menampilkan yang berikut ini:

    { "id": 4, "type": "bird", "price": 999.99 }

Langkah 3: Menyebarkan API

Pada langkah ini, Anda menerapkan API sehingga Anda dapat mulai memanggilnya di luar konsol API Gateway.

Untuk menyebarkan API
  1. Pilih DeployAPI.

  2. Untuk Stage, pilih Prod.

  3. (Opsional) Untuk Deskripsi, masukkan deskripsi.

  4. Pilih Deploy.

Langkah 4: Uji API

Pada langkah ini, Anda pergi ke luar konsol API Gateway dan menggunakan konsol Anda API untuk mengakses HTTP titik akhir.

  1. Di panel navigasi utama, pilih Stage.

  2. Di bawah Detail tahap, pilih ikon salin untuk menyalin API panggilan Anda. URL

    Seharusnya terlihat seperti ini:

    https://my-api-id.execute-api.region-id.amazonaws.com/prod
  3. Masukkan ini URL di kotak alamat tab browser baru dan tambahkan /pets/4 ke URL sebelum Anda mengirimkan permintaan Anda.

  4. Browser akan mengembalikan yang berikut:

    { "id": 4, "type": "bird", "price": 999.99 }

Langkah selanjutnya

Anda dapat menyesuaikan lebih lanjut API dengan mengaktifkan validasi permintaan, mengubah data, atau membuat respons gateway khusus.

Untuk menjelajahi lebih banyak cara untuk menyesuaikan AndaAPI, lihat tutorial berikut: