Uji paket penggunaan untuk REST APIs di API Gateway

Sebagai contoh, mari kita gunakan PetStore API, yang dibuat diTutorial: Buat REST API dengan mengimpor contoh. Asumsikan bahwa API dikonfigurasi untuk menggunakan kunci API dariHiorr45VR...c4GJc. Langkah-langkah berikut menjelaskan cara menguji rencana penggunaan.

Untuk menguji paket penggunaan Anda

• Buat GET permintaan pada resource Pets (/pets), dengan parameter ?type=...&page=... kueri, API (misalnya,xbvxlpijch) dalam paket penggunaan:

  GET /testStage/pets?type=dog&page=1 HTTP/1.1
  x-api-key: Hiorr45VR...c4GJc
  Content-Type: application/x-www-form-urlencoded
  Host: xbvxlpijch.execute-api.ap-southeast-1.amazonaws.com
  X-Amz-Date: 20160803T001845Z
  Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160803/ap-southeast-1/execute-api/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-api-key, Signature={sigv4_hash}
  

  catatan

  Anda harus mengirimkan permintaan ini ke execute-api komponen API Gateway dan memberikan kunci API yang diperlukan (misalnya,Hiorr45VR...c4GJc) di x-api-key header yang diperlukan.

  Respons yang berhasil mengembalikan kode 200 OK status dan payload yang berisi hasil yang diminta dari backend. Jika Anda lupa mengatur x-api-key header atau mengaturnya dengan kunci yang salah, Anda mendapatkan 403 Forbidden respons. Namun, jika Anda tidak mengonfigurasi metode untuk memerlukan kunci API, kemungkinan besar Anda akan mendapatkan 200 OK respons apakah Anda menyetel x-api-key header dengan benar atau tidak, dan batas throttle dan kuota paket penggunaan dilewati.

  Kadang-kadang, ketika terjadi kesalahan internal di mana API Gateway tidak dapat menerapkan batas pembatasan rencana penggunaan atau kuota untuk permintaan tersebut, API Gateway melayani permintaan tanpa menerapkan batas pembatasan atau kuota seperti yang ditentukan dalam paket penggunaan. Tapi, itu mencatat pesan kesalahan Usage Plan check failed due to an internal error in CloudWatch. Anda dapat mengabaikan kesalahan sesekali seperti itu.