Menggunakan modul akses apigee

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X.
info

Modul apigee-access memungkinkan Anda mengakses cache dan variabel alur proxy API dari dalam kode aplikasi Node.js. Modul ini disertakan dengan platform Apigee Edge. Anda tidak perlu menginstalnya seperti yang Anda lakukan dengan modul Node.js lainnya.

Memperoleh akses apigee

Modul apigee-access terintegrasi ke dalam platform Apigee Edge. Saat Anda men-deploy kode Node.js ke Edge, modul ini akan tersedia untuk Anda. Anda hanya perlu mewajibkannya dalam kode Node.js yang di-deploy. Contoh:

var access=require('apigee-access');

Mengakses variabel flow

Saat men-deploy aplikasi Node.js ke Edge, Anda dapat mengakses salah satu variabel alur "bawaan" yang didukung, variabel alur yang dibuat oleh kebijakan, dan variabel alur apa pun yang Anda buat sendiri dari dalam kode Node.js. Variabel flow dibuat dan ada dalam konteks proxy API yang berjalan di Edge. Untuk informasi selengkapnya, lihat Mengakses variabel alur di Node.js.

Mengakses cache

Modul apigee-access memungkinkan Anda mengakses cache terdistribusi Apigee Edge dari kode Node.js Anda. Untuk informasi selengkapnya, lihat Mengakses cache di Node.js.

Menggunakan layanan kuota

Dengan modul apigee-access, Anda dapat mengakses layanan kuota Apigee Edge dari kode Node.js. Untuk informasi selengkapnya, lihat Mengakses layanan kuota di Node.js.

Mengakses Peta Nilai Kunci

Dengan modul apigee-access, Anda dapat mengakses peta nilai kunci (KVM) Apigee Edge dari kode Node.js Anda. Untuk informasi selengkapnya, lihat Mengakses peta nilai kunci di Node.js.

Berjalan dalam mode lokal vs mode yang di-deploy

Untuk mendukung pengembangan dan pengujian lokal, modul apigee-access berfungsi dalam mode lokal tanpa dependensi di Apigee Edge. Namun, jika modul digunakan dengan proxy API yang di-deploy ke Edge, fungsi "lokal" akan digantikan dengan fungsi Edge native. Misalnya, pelengkap lengkap variabel alur dapat diakses dalam mode di-deploy, sedangkan hanya sebagian kecil yang tersedia saat Anda menjalankan aplikasi Node.js secara lokal. Untuk daftar variabel mode lokal ini, lihat Menjalankan dalam mode lokal.

Menentukan mode yang digunakan untuk menjalankan modul

Untuk menentukan di mode mana Anda menjalankan apigee-access:

var access = require('apigee-access')
console.log('The deployment mode is ' + access.getMode());

Nilai getMode() yang ditampilkan memberi tahu Anda apakah aplikasi Node.js di-deploy ke Apigee Edge atau berjalan dalam mode mandiri atau tidak. Metode tersebut akan menampilkan salah satu dari dua hasil string berikut:

  • apigee - Aplikasi Node.js dijalankan di Apigee Edge dan semua fungsinya didukung.
  • standalone - Aplikasi Node.js berjalan di luar lingkungan Apigee Edge, dan fungsi default yang dijelaskan di bagian atas dokumen akan diterapkan.

Berjalan dalam mode di-deploy

Saat di-deploy ke Edge, variabel yang ditetapkan oleh kebijakan akan terlihat oleh apigee-access, dan variabel yang ditambahkan atau diubah oleh metode modul ini dapat dilihat oleh kebijakan berikutnya dalam alur proxy.

Anda dapat menemukan link variabel yang didukung di Referensi Variabel. Variabel ini, dan yang Anda buat dengan nama Anda sendiri, akan terlihat oleh apigee-access. Perhatikan bahwa beberapa variabel bersifat hanya baca. Variabel tersebut diidentifikasi dalam Referensi Variabel.

Berjalan dalam mode lokal

Dalam "mode lokal", Anda menjalankan kode Node.js di luar konteks Apigee Edge. Dalam mode ini, sebagian besar variabel alur yang telah ditetapkan tidak dapat diakses dalam kode Node.js Anda. Tabel ini menunjukkan sebagian kecil variabel flow yang tersedia. Variabel ini didukung di sini guna mendukung pengembangan dan pengujian lokal aplikasi Node.js untuk Apigee Edge.

Variabel Hanya Baca Jenis Catatan
client.received.start.time Ya String Waktu saat permintaan diterima
client.received.end.time Ya String Waktu saat permintaan diterima
client.received.start.timestamp Ya Bilangan Bulat Waktu saat permintaan diterima
client.received.end.timestamp Ya Bilangan Bulat Waktu saat permintaan diterima

Sekali lagi, di platform Apigee Edge, kumpulan variabel standar yang jauh lebih besar didukung. Lihat Referensi Variabel Apigee Edge untuk mengetahui daftar lengkapnya.