Meneruskan data ke dan dari layanan backend
Saat klien API membuat permintaan ke API Anda yang di-deploy di API Gateway, klien dapat meneruskan sebagian atau semua informasi berikut sebagai bagian dari permintaan:
- Header permintaan
- Parameter kueri
- Data formulir
- Payload XML atau JSON
- Jalur permintaan
Dalam membuat respons terhadap permintaan API, layanan backend dapat menampilkan data ke klien API, termasuk:
- Header respons
- Payload XML atau JSON
Dokumen ini menjelaskan cara data ini diteruskan ke dan dari layanan backend.
Bagaimana data permintaan diteruskan ke layanan backend?
Semua data dalam permintaan dari klien API diteruskan tanpa perubahan ke layanan backend. Kemudian, layanan backend akan mem-parsing data permintaan sebagai bagian dari penanganan permintaan.
Bagaimana data respons ditampilkan ke klien API?
Semua data yang diterima dalam respons dari layanan backend diteruskan tanpa diubah ke klien API. Selanjutnya, klien API yang akan memproses data apa pun yang ditampilkan dalam respons.
Bagaimana URL permintaan diteruskan ke layanan backend?
URL yang digunakan untuk membuat permintaan ke layanan backend dikontrol oleh ekstensi
x-google-backend.
Bagian ini menjelaskan opsi untuk mengonfigurasi URL layanan backend.
Menetapkan alamat dan jalur layanan backend dalam spesifikasi OpenAPI
Dalam spesifikasi OpenAPI yang Anda gunakan untuk membuat konfigurasi API, Anda menggunakan ekstensi
x-google-backend untuk menentukan URL layanan backend.
Misalnya, Anda menentukan layanan backend dalam formulir:
| Backend | x-google-backend |
|---|---|
| Cloud Run Functions | x-google-backend: address: https://GCP_REGION-PROJECT_ID.cloudfunctions.net/hello |
| Cloud Run | Salah satu dari berikut ini:
|
| Lingkungan standar App Engine | x-google-backend: address: https://PROJECT_ID.appspot.com |
Dalam contoh ini:
- APP_URL menentukan URL sebenarnya dari layanan Cloud Run Anda (jalur lengkap API yang dipanggil), yang juga disebut sebagai URL non-deterministik. Misalnya:
https://hello-abc1def2gh-uc.a.run.app - DETERMINISTIC_URL adalah URL deterministik untuk backend layanan Cloud Run Anda.