Halaman ini berlaku untuk Apigee dan Apigee Hybrid.
Baca dokumentasi
Apigee Edge.
Topik ini mencantumkan beberapa karakteristik dasar proxy API, beserta link ke informasi selengkapnya.
API adalah titik entri bagi satu aplikasi untuk menggunakan kemampuan aplikasi lain. Anda menerapkan proxy API untuk membuat API
Di Apigee, Anda mengimplementasikan proxy API dengan mengonfigurasi logika proxy API sebagai urutan langkah-langkah yang dijalankan sebagai respons terhadap permintaan dari kode klien. Anda mengekspos proxy API ke klien dengan menentukan endpoint yang menyertakan URL dengan jalur resource, kata kerja HTTP, persyaratan isi, dan sebagainya.
Meskipun disebut proxy API, dari perspektif kode klien, ini adalah API.
Untuk ringkasan tentang proxy API, lihat Memahami API dan proxy API.
Anda menyusun urutan logika proxy API menggunakan alur
Di aplikasi apa pun, data mengalir melalui aplikasi yang dipandu oleh logika kondisi. Di Apigee, jalur pemrosesan terdiri dari alur. Alur adalah urutan tahapan (atau "langkah") yang membentuk jalur pemrosesan proxy API. Alur adalah cara Apigee menyediakan tempat bagi Anda untuk menerapkan logika dan perilaku di tempat tertentu dari klien ke resource backend, lalu kembali ke klien.
Untuk mengetahui informasi selengkapnya tentang alur, lihat Mengontrol cara proxy dieksekusi dengan flow
Anda mengakses data status melalui variabel aliran yang dibuat oleh proxy API
Proxy API memiliki akses ke variabel yang mewakili status eksekusi. Anda dapat mengakses variabel ini dari XML yang mengonfigurasi proxy dan kebijakan API Anda. Anda juga dapat mengaksesnya saat memperluas proxy API dengan bahasa sesuai prosedur, seperti Java, JavaScript, atau Python.
Variabel ini disimpan oleh Apigee. Ada beberapa proxy yang ada secara default, biasanya karena ini sama dengan fungsi proxy API (misalnya, karena merupakan bagian dari permintaan HTTP). Anda juga dapat membuat variabel sendiri untuk memenuhi persyaratan logika.
Untuk mengetahui informasi selengkapnya tentang variabel, lihat Mengelola status proxy dengan variabel alur.
Anda dapat membuat proxy API dijalankan secara bersyarat
Sama seperti kebanyakan bahasa pemrograman, di proxy API Anda dapat mengeksekusi kode secara bersyarat. Kondisi sering kali didasarkan pada status proxy API, yang dapat Anda akses melalui variabel alur. Misalnya, Anda dapat memiliki kondisi yang memeriksa agen pengguna, lalu memproses permintaan sebagaimana mestinya.
Untuk mengetahui informasi selengkapnya tentang eksekusi bersyarat, lihat Kondisi dengan variabel alur.
Anda menerapkan sebagian besar logika di proxy API menggunakan kebijakan
Sebagian besar logika yang Anda tambahkan ke proxy API dikemas sebagai kebijakan. Kebijakan adalah komponen Apigee yang mengenkapsulasi logika untuk area fungsional, seperti pengelolaan traffic atau keamanan. Anda mengonfigurasi kebijakan dengan XML yang menetapkan properti untuk logika yang mendasarinya. Anda menyusun kebijakan dalam urutan "langkah" dalam alur, sehingga proxy API mengeksekusi logika dalam urutan terbaik untuk sasaran proxy Anda.
Untuk informasi selengkapnya tentang kebijakan, lihat Apa yang dimaksud dengan kebijakan?.
Anda dapat menyertakan kumpulan fungsi yang dapat digunakan kembali
Jika proxy API menyertakan logika yang akan digunakan dari beberapa tempat dalam kode—seperti proxy API lainnya—Anda dapat mengumpulkan logika tersebut untuk panggilan dari beberapa tempat. Misalnya, Anda dapat mengelompokkan logika keamanan dalam alur bersama yang dipanggil oleh proxy API lain, sehingga mengurangi duplikasi di seluruh proxy API.
Untuk informasi selengkapnya tentang alur bersama, lihat Alur bersama yang dapat digunakan kembali. Untuk informasi selengkapnya tentang perantaian proxy API, lihat Membuat rantai proxy API bersama-sama.
Anda dapat men-debug proxy dengan alat Debug
Apigee menyertakan alat Debug yang dapat Anda gunakan untuk memeriksa alur eksekusi proxy API saat melakukan proses debug dan pengujian. Alat ini secara visual menampilkan setiap langkah proxy API yang dijalankan untuk sebuah permintaan. Seperti pada debugger, di setiap langkah Anda dapat melihat daftar nilai variabel yang membentuk status proxy API.
Untuk mengetahui informasi selengkapnya tentang proses debug dengan alat Debug, lihat Alat debug.
Anda menangani error proxy API sebagai kesalahan
Dengan mengonfigurasi pengendali kesalahan, Anda dapat menyesuaikan error yang ditampilkan ke klien API. Pengendali kesalahan memberi Anda kontrol atas pesan error, apakah error tersebut berasal dari kode Anda sendiri atau dari komponen yang disertakan (seperti kebijakan).
Untuk mengetahui informasi selengkapnya, lihat Menangani kesalahan.