Variabel permintaan dan respons

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Baca dokumentasi Apigee Edge.

Saat membuat permintaan ke proxy API, Anda dapat meneruskan salah satu atau semua informasi berikut, bergantung pada cara proxy API dikonfigurasi:

• Header permintaan
• Parameter kueri
• Data formulir
• Payload XML atau JSON
• URI Resource

Secara default, semua data dalam permintaan diteruskan tanpa perubahan dari ProxyEndpoint ke TargetEndpoint. Oleh karena itu, saat TargetEndpoint membuat permintaan ke server backend, semua informasi dalam permintaan asli akan diteruskan ke layanan backend.

Hal yang sama berlaku untuk respons yang diterima Apigee dari layanan backend. Secara default, semua data yang diterima dalam respons diteruskan tanpa perubahan ke aplikasi yang menghasilkan permintaan.

Bagaimana data permintaan diteruskan ke server backend?

Gambar berikut menunjukkan definisi proxy API:

Untuk proxy API ini:

• Host virtual proxy API: default
• Domain ditentukan oleh nama host di grup lingkungan: http://www.example.com
• Jalur dasar proxy: /v1/weather
• TargetEndpoint yang ditentukan oleh aturan rute: default
• URL Target: http://weather.yahooapis.com

Aplikasi klien membuat permintaan GET ke proxy API menggunakan perintah curl berikut:

curl -X GET http://www.example.com/v1/weather/forecastrss?w=12797282

Perhatikan bahwa permintaan ini berisi resource forecastrss dan satu parameter kueri, w. Apigee mengurai permintaan seperti yang ditunjukkan di bawah ini, dan menetapkan bagian permintaan tersebut ke variabel flow:

{request.verb} {proxy.basepath}/{proxy.pathsuffix}?{request.querystring}

Variabel alur ditetapkan dengan nilai berikut:

• request.verb: GET
• proxy.basepath: /v1/weather
• proxy.pathsuffix: forecastrss
• request.querystring: w=12797282

Catatan: Ada banyak variabel alur berbeda yang dibuat selama pemrosesan permintaan dan respons. Lihat Referensi variabel flow untuk mengetahui informasi selengkapnya.

TargetEndpoint kemudian membuat permintaan ke layanan backend menggunakan informasi dari permintaan tersebut:

{request.verb} {target.basepath}/{proxy.pathsuffix}?{request.querystring}

Perhatikan bagaimana parameter kueri dan resource yang ditentukan dalam permintaan otomatis disertakan dalam permintaan ke server backend. Dari definisi TargetEndpoint, permintaan tersebut kemudian memiliki bentuk:

curl -X GET http://weather.yahooapis.com/forecastrss?w=12797282

Seperti parameter kueri, header atau parameter formulir apa pun yang Anda sertakan dalam permintaan ke proxy API akan diteruskan ke server backend. Misalnya, Anda membuat permintaan di bawah ini yang menyertakan header:

curl -X GET -H 'Content-type:application/xml' http://www.example.com/v1/weather/forecastrss?w=12797282

Atau permintaan dalam formulir di bawah untuk menyertakan data formulir dan header:

curl -X POST -H "Content-type:application/json" -d \
  '{"email" : "[e-mail]",
    "firstName" : "Jane",
    "lastName" : "Tutorial",
    "userName" : "jtutorialxml"
  }' \
  http://www.example.com/v1/register/user

Dalam kedua contoh tersebut, header dan data formulir diteruskan tanpa perubahan ke layanan backend. Header direpresentasikan oleh variabel alur seperti request.headers.count dan request.headers.names. Data formulir direpresentasikan oleh variabel alur seperti request.formparam.count dan request.formparam.names.

Bagaimana data respons ditampilkan?

Secara default, semua data yang diterima oleh Apigee dari layanan backend dalam respons diteruskan tanpa perubahan ke aplikasi yang menghasilkan permintaan. Seperti yang dijelaskan di atas untuk permintaan, data yang ditampilkan dalam respons dapat diakses melalui variabel alur di Apigee. Untuk informasi selengkapnya, lihat Referensi variabel flow.

Mengakses data permintaan dan respons di proxy API

Sering kali Anda ingin mengubah data permintaan sebelum mengirimkannya ke server backend. Contoh:

• Untuk menghapus informasi keamanan yang digunakan oleh Apigee untuk memvalidasi permintaan. Informasi tersebut tidak diperlukan oleh layanan backend.
• Untuk menambahkan data yang dikirim ke layanan backend, misalnya untuk melacak pengguna atau mengumpulkan analisis.
• Untuk memproses permintaan secara kondisional berdasarkan data permintaan. Misalnya, proxy API dapat memiliki beberapa TargetEndpoint. TargetEndpoint yang digunakan oleh permintaan ditentukan berdasarkan data permintaan. Kemudian, Anda perlu menghapus data tersebut dari permintaan sebelum mengirimkannya ke layanan backend.

Hal yang sama berlaku untuk data dalam respons. Sebagai bagian dari pemrosesan respons, proxy API mungkin ingin mengubah data sebelum menampilkannya ke aplikasi yang meminta.

Pesan permintaan akses

Anda dapat menggunakan kebijakan untuk mengakses dan mengubah bagian pesan permintaan. Bagian ini mencakup:

• Header
• Parameter kueri
• Parameter formulir
• Alamat IP Sumber
• Isi pesan HTTP

Dalam alur normal, setelah permintaan diproses, proxy kemudian mengirimkan permintaan yang telah ditransformasi ke target.

Kebijakan dapat memeriksa variabel permintaan, lalu mengubah atau menolak permintaan berdasarkan isi variabel tersebut. Kebijakan mengubah permintaan dengan menetapkan variabel yang sesuai, misalnya variabel yang sesuai dengan header permintaan.

Tips: Anda dapat menggunakan variabel untuk merekonstruksi URL permintaan yang masuk. Misalnya, kode berikut dalam kebijakan JavaScript menyusun URL permintaan dari bagian-bagiannya:

var req_verb = context.getVariable('request.verb');
var req_scheme = context.getVariable('client.scheme');
var req_host = context.getVariable('request.header.host');
var req_request_uri = context.getVariable('request.uri');
var req_url = req_scheme + "://" + req_host + req_request_uri;

Hasil penggabungan mungkin terlihat seperti berikut:

https://www.example.com/sample

Mengakses pesan respons

Dengan menggunakan variabel yang berlaku untuk pesan respons, kebijakan dapat mengakses komponen pesan, termasuk header, parameter kueri, dan parameter formulir, alamat IP sumber, isi pesan HTTP, dan sebagainya.

Proxy menerima pesan respons, lalu menerapkan serangkaian kebijakan padanya, berdasarkan kondisi yang dievaluasi pada respons, yang dapat memodifikasi atau mentransformasi respons.

Kebijakan dapat memeriksa variabel respons, lalu mengubah atau menolak permintaan berdasarkan isi variabel tersebut. Kebijakan mengubah respons dengan menetapkan variabel yang sesuai, misalnya variabel yang sesuai dengan header respons.

Kebijakan umum untuk mengakses variabel alur

Apigee menentukan beberapa kebijakan yang dapat Anda gunakan untuk memproses data permintaan dan respons. Kebijakan ini mencakup:

• Kebijakan TetapkanMessage: Membuat atau mengubah pesan respons atau permintaan HTTP selama alur proxy API. Juga membuat dan mengisi variabel flow baru.
• Kebijakan ExtractVariables: Ekstrak konten dari pesan, termasuk header, jalur URI, payload, dan parameter kueri, untuk digunakan dalam pernyataan kondisi. Kebijakan tersebut kemudian menerapkan pola teks ke konten pesan dan setelah menemukan kecocokan, menetapkan variabel yang ditetapkan.
• Kebijakan JSONtoXML dan kebijakan XMLtoJSON: Konversikan pesan dari JavaScript Object Notation (JSON) ke format extensible markup language (XML), atau sebaliknya.
• Kebijakan JavaCallout, kebijakan JavaScript, kebijakan PythonScript, kebijakan RegularExpressionProtection: Kebijakan ini memungkinkan Anda menulis skrip untuk mengakses variabel alur yang berisi data permintaan dan respons.