Menggunakan contoh proxy API

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

Prasyarat

Anda memerlukan akun di http://enterprise.apigee.com. Anda dapat mendaftar untuk akun uji coba di http://accounts.apigee.com/accounts/sign_up.

Untuk menggunakan contoh, Anda juga harus memiliki hal berikut:

Alat Deskripsi
Git Contoh tersebut ada di GitHub. Jika Anda belum menginstal Git, lihat Petunjuk penyiapan git GitHub. Jika tidak ingin menginstal Git, Anda dapat menjelajahi file dan mendownload ZIP dari https://github.com/apigee/api-platform-samples.
Python

Python diperlukan untuk menjalankan alat deploy Apigee. Python ada di sebagian besar Linux di Mac yang menginstal XCode, di komputer Windows yang menginstal Cygwin, dan di berbagai tempat lainnya.

Untuk mendapatkan Python, lihat Halaman download Python.
curl Contoh skrip penyiapan juga menggunakan curl. Pastikan curl sudah diinstal dan tersedia di jalur Anda (jalankan perintah which curl untuk melihat apakah ini tersedia di sistem Anda).
dos2unix Jika menjalankan Cygwin di Windows, Anda mungkin juga memerlukan dos2unix utilitas. (Penginstal Cygwin memungkinkan Anda menginstal utilitas tersebut.)

Download contohnya

Untuk mendapatkan file contoh, gunakan git clone seperti yang ditunjukkan contoh berikut:

git clone https://github.com/apigee/api-platform-samples.git

Mengimpor dan men-deploy API contoh {i>proxy<i}

Impor dan deploy sampel dari command line:

  1. Setelah mendownload contoh, buka direktori /setup, seperti yang ditunjukkan contoh berikut: 
    cd setup
  2. Dalam direktori /setup, cari file setenv.sh.
  3. Edit file ini untuk menyetel organisasi, alamat email yang terkait dengan nama pengguna, dan lingkungan (prod atau pengujian) tempat Anda ingin men-deploy proxy API.
  4. Setelah mengedit setenv.sh, jalankan perintah berikut: 
    sh deploy_all.sh

    Skrip ini men-deploy semua sampel proxy API ke organisasi Anda. (Proses ini memakan waktu 3-4 minutes.) Ikuti petunjuk untuk men-deploy produk, developer, dan aplikasi API (yang digunakan untuk OAuth).

  5. Setelah skrip deployment selesai, buka direktori sample-proxy. Di kolom sample-proxies, Anda akan menemukan satu direktori per proxy sampel. Dalam setiap adalah file README.md dengan informasi tentang menjalankan sampel, dan dua skrip yang membantu Anda saat membuat perubahan kecil pada sampel, men-deploy, lalu memanggil sampel untuk melihat dampak yang Anda ubah:
    • invoke.sh: Menjalankan skrip ini untuk memanggil versi API yang di-deploy {i>proxy<i}.
    • deploy.sh: Jalankan skrip ini untuk men-deploy proxy API setelah Anda membuat perubahan.

Memanggil contoh proxy API

Setiap proxy contoh memiliki skrip shell terkait yang dapat digunakan untuk memanggil proxy API setelah Anda men-deploy-nya.

Dari direktori /sample-proxies/proxy_name, jalankan berikut ini:

sh invoke.sh

Tindakan ini akan memanggil proxy yang berjalan di lingkungan pengujian di organisasi Anda.

Pemecahan masalah

Untuk informasi pemecahan masalah, lihat referensi berikut:

Mengubah dan menggunakan kembali proxy API contoh

Penggunaan umum proxy contoh adalah untuk memodifikasi, men-deploy, dan memanggil. Hal ini memungkinkan Anda untuk membuat modifikasi kecil, dan kemudian untuk melihat efeknya pada pesan respons.

Untuk memodifikasi contoh proxy API agar mengarah ke layanan backend yang berbeda, ubah parameter File konfigurasi XML di lokasi berikut:

/apiproxy/targets/target_name.xml

Misalnya, untuk mengarahkan contoh kunci API ke layanan backend Anda sendiri, cari file ini:

/apikey/apiproxy/targets/default.xml

Jika konfigurasi default mengarah ke http://mocktarget.apigee.net, seperti:

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://mocktarget.apigee.net</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

dan layanan backend Anda tersedia di http://api.myproject.com/, maka Anda ubah konfigurasi agar terlihat seperti berikut:

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://api.myproject.com/</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

Setelah Anda menyimpan perubahan, deploy proxy API seperti yang ditampilkan dalam contoh berikut:

sh deploy.sh

Proxy API lainnya dapat diubah dengan cara yang sama agar dapat menggunakan fungsi proxy API dibandingkan layanan target yang sudah ada. Namun, dalam beberapa kasus, perilaku proxy API bergantung pada format pesan tertentu, sehingga {i>proxy<i} mungkin memerlukan perubahan konfigurasi tambahan.