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 mendapatkan akun uji coba di http://accounts.apigee.com/accounts/sign_up.

Untuk menggunakan contoh, Anda juga harus memiliki hal berikut:

Alat Deskripsi
Git Contoh ini tersedia 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 lingkungan Linux, pada Mac dengan XCode yang diinstal, di mesin Windows dengan bawa-bawa yang terinstal, dan di banyak tempat lainnya.

Untuk mendapatkan Python, lihat halaman download Python.

curl Contoh skrip penyiapan juga menggunakan curl. Pastikan curl diinstal dan tersedia di jalur Anda (jalankan perintah which curl untuk mengetahui apakah tersedia di sistem Anda atau tidak).
dos2unix Jika menjalankan Kini di Windows, Anda mungkin juga memerlukan utilitas dos2unix. (Penginstal dSYM memungkinkan Anda menginstal utilitas tersebut.)

Download contohnya

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

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

Mengimpor dan men-deploy contoh proxy API

Impor dan deploy sampel dari command line:

  1. Setelah mendownload contoh, buka direktori /setup, seperti yang ditunjukkan pada contoh berikut:
    cd setup
  2. Dalam direktori /setup, cari file setenv.sh.
  3. Edit file ini untuk menetapkan organisasi Anda, alamat email yang terkait dengan nama pengguna, dan lingkungan (produsen 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 contoh proxy API ke organisasi Anda. (Proses ini memerlukan waktu 3-4 menit.) Ikuti petunjuk untuk men-deploy produk, developer, dan aplikasi API (yang digunakan untuk OAuth).

  5. Setelah skrip deploy selesai, buka direktori proxy sampel. Dalam direktori sample-proxies, Anda akan menemukan satu direktori per contoh proxy. Di setiap direktori terdapat file README.md yang berisi informasi cara menjalankan sampel, dan dua skrip yang dapat membantu Anda saat melakukan perubahan kecil pada sampel, men-deploy, lalu memanggil sampel untuk melihat dampak perubahan Anda:
    • 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 melakukan perubahan.

Memanggil proxy API contoh

Setiap proxy contoh memiliki skrip shell terkait yang dapat digunakan untuk memanggil proxy API setelah Anda menerapkannya.

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

sh invoke.sh

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

Pemecahan masalah

Untuk informasi pemecahan masalah, lihat referensi berikut:

Mengubah dan menggunakan kembali contoh proxy API

Penggunaan umum proxy contoh adalah untuk memodifikasi, men-deploy, dan memanggil. Dengan begitu, Anda dapat melakukan sedikit perubahan, lalu melihat pengaruhnya terhadap pesan respons.

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

/apiproxy/targets/target_name.xml

Misalnya, untuk mengarahkan contoh kunci API pada 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/, lalu 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 Anda menyimpan perubahan, deploy proxy API seperti yang ditampilkan dalam contoh berikut:

sh deploy.sh

Proxy API lainnya dapat dimodifikasi 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.