Menggunakan contoh proxy API

Anda 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 Contohnya terletak 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 deployment Apigee. Python ada di sebagian besar lingkungan Linux, di Mac dengan XCode terinstal, di mesin Windows dengan Cygwin terinstal, dan di banyak tempat lainnya.

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

Mendownload contoh

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 proxy API contoh

Impor dan deploy contoh dari command line:

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

    Skrip ini men-deploy semua contoh proxy API ke organisasi Anda. (Proses ini memerlukan waktu 3-4 menit.) Ikuti perintah untuk men-deploy produk API, developer, dan aplikasi (yang digunakan untuk OAuth).

  5. Setelah skrip deployment selesai, buka direktori sample-proxies. Di direktori sample-proxies, Anda akan menemukan satu direktori per proxy contoh. Di setiap direktori terdapat file README.md yang berisi informasi tentang cara menjalankan contoh, dan dua skrip yang membantu Anda saat membuat perubahan kecil pada contoh, men-deploy, lalu memanggil contoh untuk melihat efek perubahan yang Anda buat:
    • invoke.sh: Jalankan skrip ini untuk memanggil versi proxy API yang di-deploy.
    • deploy.sh: Jalankan skrip ini untuk men-deploy proxy API setelah Anda membuat perubahan.

Memanggil proxy API contoh

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 perintah berikut:

sh invoke.sh

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

Pemecahan masalah

Untuk mengetahui informasi pemecahan masalah, lihat hal berikut:

Mengubah dan menggunakan kembali proxy API contoh

Penggunaan umum proxy contoh adalah mengubah, men-deploy, dan memanggil. Hal ini memungkinkan Anda membuat perubahan kecil, lalu melihat pengaruhnya pada pesan respons.

Untuk mengubah proxy API contoh agar mengarah ke layanan backend yang berbeda, ubah file konfigurasi XML di lokasi berikut:

/apiproxy/targets/target_name.xml

Misalnya, untuk mengarahkan contoh kunci API ke layanan backend Anda sendiri, temukan 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 mengubah 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 menyimpan perubahan, deploy proxy API seperti yang ditunjukkan contoh berikut:

sh deploy.sh

Proxy API lainnya dapat diubah dengan cara yang sama untuk menggunakan fungsi proxy API terhadap layanan target yang ada. Namun, dalam beberapa kasus, perilaku proxy API bergantung pada format pesan tertentu, sehingga proxy mungkin memerlukan perubahan konfigurasi tambahan.