Halaman ini berlaku untuk Apigee dan Apigee Hybrid.
Lihat 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 menerapkan proxy API dengan mengonfigurasi logika proxy API sebagai urutan langkah yang dijalankan sebagai respons terhadap permintaan dari kode klien. Anda mengekspos proxy API ke klien dengan menentukan endpoint yang mencakup URL dengan jalur resource, kata kerja HTTP, persyaratan isi, dan sebagainya.
Meskipun disebut proxy API, dari perspektif kode klien, proxy API adalah API.
Untuk mengetahui ringkasan proxy API, lihat Memahami API dan proxy API.
Anda mengatur urutan logika proxy API menggunakan alur
Dalam aplikasi apa pun, data mengalir melalui aplikasi yang dipandu oleh logika kondisi. Di Apigee, jalur pemrosesan terdiri dari alur. Alur adalah urutan tahap (atau "langkah") yang membentuk jalur pemrosesan proxy API. Flow 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 alur
Anda mengakses data status melalui variabel alur yang dibuat oleh proxy API
Proxy API memiliki akses ke variabel yang merepresentasikan 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 prosedural, seperti Java, JavaScript, atau Python.
Variabel ini disimpan oleh Apigee. Beberapa sudah ada secara default, biasanya karena umum terhadap apa yang dilakukan proxy API (seperti 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 aliran.
Anda dapat membuat proxy API dijalankan secara bersyarat
Seperti dalam sebagian besar bahasa pemrograman, di proxy API Anda dapat menjalankan kode secara kondisional. 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 dengan semestinya.
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 keamanan atau pengelolaan traffic. Anda mengonfigurasi kebijakan dengan XML yang menetapkan properti untuk logika yang mendasarinya. Anda mengatur kebijakan dalam urutan "langkah" dalam alur, sehingga proxy API Anda menjalankan logika dalam urutan terbaik untuk tujuan proxy Anda.
Untuk mengetahui informasi selengkapnya tentang kebijakan, lihat Apa itu kebijakan?.
Anda dapat menyertakan set fungsionalitas yang dapat digunakan kembali
Jika proxy API Anda menyertakan logika yang akan digunakan dari beberapa tempat dalam kode Anda—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 mengetahui informasi selengkapnya tentang alur bersama, lihat Alur bersama yang dapat digunakan kembali. Untuk mengetahui informasi selengkapnya tentang penggabungan proxy API, lihat Menggabungkan proxy API secara bersamaan.
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 menampilkan secara visual setiap langkah proxy API yang dijalankan untuk permintaan. Seperti di 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 fault
Dengan mengonfigurasi pengendali fault, Anda dapat menyesuaikan error yang ditampilkan ke klien API. Handler kesalahan memberi Anda kontrol atas pesan error, baik error berasal dari kode Anda sendiri atau dari komponen yang disertakan (seperti kebijakan).
Untuk mengetahui informasi selengkapnya, lihat Menangani kesalahan.