Poin utama pengembangan proxy API

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat Dokumentasi Apigee Edge.

Topik ini mencantumkan beberapa karakteristik dasar proxy API, bersama dengan tautan ke tidak akurat atau tidak sesuai.

API merupakan titik entri bagi satu aplikasi untuk menggunakan kemampuan aplikasi lainnya. Anda menerapkan API proxy untuk membuat API

Di Apigee, Anda mengimplementasikan proxy API dengan mengonfigurasi logika proxy API sebagai urutan langkah-langkah yang dijalankan untuk merespons 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 seterusnya.

Meskipun disebut proxy API, dari perspektif kode klien, inilah Google Cloud Platform.

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

Anda mengatur urutan proxy API logika menggunakan flow

Dalam 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 untuk Anda untuk menerapkan logika dan perilaku di tempat tertentu dari klien ke resource backend, lalu kembali ke dengan klien besar.

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

Anda mengakses data negara bagian melalui variabel alur yang dibuat oleh proxy API

Proxy API memiliki akses ke variabel yang merepresentasikan status eksekusi. Anda dapat mengakses dari XML yang mengonfigurasi kebijakan dan proxy API Anda. Anda juga dapat mengaksesnya saat Anda memperluas proxy API dengan bahasa sesuai prosedur, seperti Java, JavaScript, atau Python.

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

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

Anda dapat meminta proxy API dijalankan bersyarat

Sama seperti di sebagian besar bahasa pemrograman, di proxy API, Anda dapat membuat kode dieksekusi secara kondisional. Kondisi sering kali didasarkan pada status proxy API, yang dapat Anda akses melalui variabel alur. Sebagai 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 mengimplementasikan sebagian besar logika di proxy API menggunakan kebijakan

Sebagian besar logika yang Anda tambahkan ke proxy API dikemas sebagai kebijakan. Kebijakan merupakan 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 dengan urutan "langkah" dalam alur, sehingga proxy API mengeksekusi logika dalam urutan terbaik untuk sasaran proxy Anda.

Untuk mengetahui informasi selengkapnya tentang kebijakan, lihat Apa yang dimaksud dengan kebijakan?.

Anda bisa menyertakan kumpulan yang dapat digunakan kembali, fungsionalitas

Ketika proxy API Anda menyertakan logika yang akan digunakan dari beberapa tempat dalam kode Anda—seperti sebagai proxy API lainnya—Anda dapat mengumpulkan logika tersebut untuk panggilan dari beberapa tempat. Misalnya, Anda dapat mengelompokkan logika keamanan dalam alur bersama yang dipanggil proxy API lain, sehingga mengurangi duplikasi di seluruh proxy API.

Untuk mengetahui informasi selengkapnya tentang alur bersama, lihat Dapat digunakan kembali alur bersama. Untuk informasi selengkapnya tentang pembuatan rantai proxy API, lihat proxy Chaining API bersama-sama.

Anda dapat men-debug proxy dengan alat Debug

Apigee menyertakan alat Debug yang dapat Anda gunakan untuk memeriksa eksekusi proxy API mengalir ketika proses debug dan pengujian. Alat ini secara visual menyajikan setiap langkah proxy API yang dieksekusi untuk permintaan. Seperti dalam debugger, pada setiap langkah Anda bisa melihat daftar nilai variabel yang membentuk API status proxy.

Untuk mengetahui informasi selengkapnya tentang proses debug dengan alat Debug, lihat Alat debug.

Anda menangani error proxy API sebagai kesalahan

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

Untuk mengetahui informasi selengkapnya, lihat Menangani kesalahan.