Poin utama pengembangan proxy API

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

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 Edge, 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, ini adalah API.

Untuk ringkasan tentang proxy API, lihat Memahami API dan proxy API.

Anda mengatur urutan logika proxy API menggunakan flow

Di aplikasi mana pun, data mengalir melalui aplikasi yang dipandu oleh logika kondisi. Di Apigee Edge, jalur pemrosesan terdiri dari flow. Alur adalah urutan tahapan (atau "langkah") yang membentuk jalur pemrosesan proxy API. Flow adalah cara Apigee Edge menyediakan tempat bagi Anda untuk menerapkan logika dan perilaku di tempat tertentu, mulai dari klien ke resource backend, lalu kembali ke klien.

Untuk mengetahui informasi selengkapnya tentang flow, lihat Mengontrol cara proxy dijalankan dengan flow

Anda mengakses data status melalui variabel alur 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 prosedural, seperti Java, JavaScript, atau Python.

Variabel ini disimpan oleh Apigee Edge. Beberapa proxy ada secara default, biasanya karena sifatnya yang umum dengan fungsi proxy API (misalnya karena merupakan bagian dari permintaan HTTP). Anda juga dapat membuat variabel sendiri untuk memenuhi persyaratan logika.

Untuk informasi selengkapnya tentang variabel, lihat Mengelola status proxy dengan variabel alur.

Anda dapat membuat proxy API dieksekusi secara bersyarat

Sama seperti sebagian besar bahasa pemrograman, di proxy API, Anda dapat membuat kode dieksekusi 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 dengan semestinya.

Untuk mengetahui informasi selengkapnya tentang eksekusi bersyarat, lihat Variabel dan kondisi flow.

Anda menerapkan sebagian besar logika dalam proxy API menggunakan kebijakan

Sebagian besar logika yang Anda tambahkan ke proxy API dikemas sebagai kebijakan. Kebijakan adalah komponen Apigee Edge yang mengenkapsulasi logika untuk area fungsional, seperti keamanan atau pengelolaan traffic. Anda akan mengonfigurasi kebijakan dengan XML yang menetapkan properti untuk logika yang mendasarinya. Anda mengatur kebijakan dalam urutan "langkah" dalam flow, sehingga proxy API mengeksekusi logika dalam urutan terbaik untuk sasaran proxy Anda.

Untuk informasi selengkapnya tentang kebijakan, lihat Apa itu kebijakan?.

Anda dapat menyertakan kumpulan fungsionalitas yang dapat digunakan kembali

Jika proxy API Anda 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 mengetahui 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.

Anda dapat men-debug proxy dengan alat Trace

Apigee Edge menyertakan alat Trace 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 Trace, lihat Menggunakan alat Trace.

Anda menangani error proxy API sebagai kesalahan

Dengan mengonfigurasi pengendali fault, Anda dapat menyesuaikan error yang ditampilkan ke klien API. Pengendali kesalahan memberi Anda kontrol atas pesan error, terlepas dari apakah error tersebut berasal dari kode Anda sendiri atau dari komponen yang disertakan (seperti kebijakan).

Untuk mengetahui informasi selengkapnya, lihat Menangani kesalahan.