Memanggil REST API di API Gateway - APIGerbang Amazon
Mendapatkan URL pemanggilan APIMemanggil API

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

Memanggil REST API di API Gateway

Untuk memanggil API yang diterapkan, klien mengirimkan permintaan ke URL untuk layanan komponen API Gateway untuk eksekusi API, yang dikenal sebagaiexecute-api.

URL dasar untuk REST API adalah dalam format berikut: 

https://api-id.execute-api.region.amazonaws.com/stage/

di mana api-id adalah pengidentifikasi API, wilayah adalah AWS Wilayah, dan stage adalah nama panggung penerapan API.

penting

Sebelum Anda dapat menjalankan API, Anda harus menerapkannya di API Gateway. Untuk petunjuk tentang penerapan API, lihatTerapkan REST APIs di API Gateway.

Topik

Mendapatkan URL pemanggilan API

Anda dapat menggunakan konsol, definisi OpenAPI AWS CLI, atau yang diekspor untuk mendapatkan URL pemanggilan API.

Mendapatkan URL pemanggilan API menggunakan konsol

Prosedur berikut menunjukkan cara mendapatkan URL pemanggilan API di konsol REST API.

Untuk mendapatkan URL pemanggilan API menggunakan konsol REST API

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

  2. Pilih API yang diterapkan.

  3. Dari panel navigasi utama, pilih Stage.

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

    URL ini untuk sumber daya root API Anda.

    Setelah Anda membuat REST API, konsol akan menampilkan URL pemanggilan API Anda.

  5. Untuk mendapatkan URL pemanggilan API untuk sumber daya lain di API Anda, perluas tahapan di bawah panel navigasi sekunder, lalu pilih metode.

  6. Pilih ikon salin untuk menyalin URL pemanggilan tingkat sumber daya API Anda.

    URL tingkat sumber daya untuk REST API Anda berada di bawah panel navigasi sekunder panggung.

Mendapatkan URL pemanggilan API menggunakan AWS CLI

Prosedur berikut menunjukkan cara mendapatkan URL pemanggilan API menggunakan. AWS CLI

Untuk mendapatkan URL pemanggilan API menggunakan AWS CLI

  1. Gunakan perintah berikut untuk mendapatkanrest-api-id. Perintah ini mengembalikan semua rest-api-id nilai di Wilayah Anda. Untuk informasi lebih lanjut, lihat get-rest-apis.

    aws apigateway get-rest-apis

  2. Ganti contoh rest-api-id dengan contoh Andarest-api-id, ganti contoh {stage-name} dengan {stage-name} Anda, dan ganti {region}, dengan Region Anda.

    https://{restapi_id}.execute-api.{region}.amazonaws.com/{stage_name}/
Memperoleh URL pemanggilan API menggunakan file definisi OpenAPI yang diekspor dari API

Anda juga dapat membuat URL root dengan menggabungkan host dan basePath bidang file definisi OpenAPI yang diekspor dari API. Untuk petunjuk tentang cara mengekspor API Anda, lihatEkspor a REST API dari API Gateway.

Memanggil API

Anda dapat memanggil API yang digunakan menggunakan browser, curl, atau aplikasi lain, seperti Postman.

Selain itu, Anda dapat menggunakan konsol API Gateway untuk menguji panggilan API. Pengujian menggunakan TestInvoke fitur API Gateway, yang memungkinkan pengujian API sebelum API diterapkan. Untuk informasi selengkapnya, lihat Menggunakan konsol API Gateway untuk menguji metode REST API.

catatan

Nilai parameter string kueri dalam URL pemanggilan tidak dapat berisi. %%

Memanggil API menggunakan browser web

Jika API Anda mengizinkan akses anonim, Anda dapat menggunakan browser web apa pun untuk menjalankan metode apa punGET. Masukkan URL pemanggilan lengkap di bilah alamat browser.

Untuk metode lain atau panggilan yang diperlukan otentikasi, Anda harus menentukan payload atau menandatangani permintaan. Anda dapat menangani ini dalam skrip di belakang halaman HTML atau dalam aplikasi klien menggunakan salah satu AWS SDK.

Memanggil API menggunakan curl

Anda dapat menggunakan alat seperti curl di terminal Anda untuk memanggil API Anda. Contoh perintah curl berikut memanggil metode GET pada getUsers sumber daya prod tahap API.

Linux or Macintosh
curl -X GET 'https://b123abcde4.execute-api.us-west-2.amazonaws.com/prod/getUsers'
Windows
curl -X GET "https://b123abcde4.execute-api.us-west-2.amazonaws.com/prod/getUsers"