Memahami API dan proxy API

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

Dengan Apigee Edge, Anda dapat membangun API RESTful dengan mudah dan cepat yang dapat digunakan oleh developer aplikasi. Anda mengekspos API di Edge dengan membuat proxy API yang bertindak sebagai 'fasasi' terkelola untuk layanan backend. Topik ini membahas hubungan antara API dan proxy API di Apigee Edge.

Video: Tonton video singkat ini untuk mengetahui pengantar proxy API.

Apa yang dimaksud dengan API?

API adalah antarmuka yang memudahkan satu aplikasi untuk 'memakai' kemampuan atau data dari aplikasi lain. Dengan menentukan titik entri yang stabil dan sederhana ke logika dan data aplikasi, API memungkinkan developer mengakses dan menggunakan kembali logika aplikasi yang dibuat oleh developer lain dengan mudah. Dalam kasus 'Web API', logika dan data tersebut diekspos melalui jaringan.

Karena aplikasi yang menggunakan API sensitif terhadap perubahan, API juga menyiratkan 'kontrak'. Kontrak ini memberikan jaminan bahwa, dari waktu ke waktu, API akan berubah dengan cara yang dapat diprediksi.

Dengan Apigee Edge, Anda dapat membuat API. Jika sudah memiliki API, Anda dapat mengeksposnya secara langsung, sekaligus menambahkan lapisan pengelolaan dan visibilitas. Jika Anda memiliki layanan yang mendukung HTTP, seperti layanan Web berbasis SOA, layanan tersebut juga dapat ditampilkan sebagai API melalui Apigee Edge.

Edge juga memungkinkan Anda membangun API dengan mengimplementasikan aplikasi yang dihosting di platform Layanan API--tanpa memerlukan layanan backend. Anda dapat membangun aplikasi ini di JavaScript, Java, dan di Node.js.

Apa itu proxy API?

Anda mengekspos API di Apigee Edge dengan mengimplementasikan proxy API. Proxy API memisahkan API yang ditampilkan ke aplikasi dari layanan backend Anda, sehingga melindungi aplikasi tersebut dari perubahan kode backend. Saat Anda membuat perubahan backend pada layanan, aplikasi terus memanggil API yang sama tanpa gangguan.

Dalam konfigurasi proxy API, ada dua jenis endpoint:

  • ProxyEndpoint: Menentukan cara aplikasi klien menggunakan API Anda. Anda mengonfigurasi ProxyEndpoint untuk menentukan URL proxy API Anda. Endpoint proxy juga menentukan apakah aplikasi mengakses proxy API melalui HTTP atau HTTPS. Anda biasanya melampirkan kebijakan ke ProxyEndpoint untuk menerapkan keamanan, pemeriksaan kuota, serta jenis kontrol akses dan pembatasan kapasitas lainnya.
  • TargetEndpoint: Menentukan cara proxy API berinteraksi dengan layanan backend Anda. Anda mengonfigurasi TargetEndpoint untuk meneruskan permintaan ke layanan backend yang tepat, termasuk menetapkan setelan keamanan, protokol HTTP atau HTTPS, dan informasi koneksi lainnya. Anda dapat melampirkan kebijakan ke TargetEndpoint untuk memastikan bahwa pesan respons diformat dengan benar untuk aplikasi yang membuat permintaan awal.

Anda dapat memvisualisasikan proxy API seperti yang ditunjukkan oleh gambar di bawah ini:

Permintaan HTTP masuk melalui endpoint permintaan proxy, diteruskan ke endpoint permintaan target, lalu dikirim ke layanan backend. Respons HTTP masuk melalui endpoint respons target, diteruskan ke endpoint respons proxy, lalu kembali ke klien.

Bagaimana cara membuat proxy API?

Proxy API terdiri dari paket kode dan file konfigurasi XML (seperti JavaScript dan Java). Apigee menyediakan beberapa cara bagi Anda untuk membuat proxy API, termasuk:

  • Menggunakan UI pengelolaan Edge untuk menentukan proxy API di Graphic User Interface (GUI). Untuk mengetahui informasi selengkapnya, lihat Membangun proxy API sederhana.
  • Membuat file XML, beserta file pendukung lainnya, yang menentukan proxy API Anda, lalu mengimpornya ke Edge.
  • Menggunakan Edge management API untuk membuat proxy API dengan membuat serangkaian permintaan REST ke Edge.
  • Deploy aplikasi Node.js sebagai proxy. Lihat Men-deploy aplikasi Node.js mandiri.

Apa itu kebijakan?

Edge memungkinkan Anda mengontrol perilaku API tanpa perlu menulis kode apa pun dengan menggunakan kebijakan. Kebijakan itu seperti modul yang menerapkan fungsi pengelolaan terbatas tertentu sebagai bagian dari alur permintaan/respons proxy. Kebijakan dirancang untuk memungkinkan Anda menambahkan jenis kemampuan pengelolaan umum ke API dengan mudah dan andal. Kebijakan menyediakan fitur seperti kemampuan keamanan, pembatasan kapasitas, transformasi, dan mediasi, sehingga Anda tidak perlu membuat kode dan memelihara fungsi ini sendiri.

Membuat proxy API pertama Anda

Apigee menyediakan serangkaian tutorial yang dapat Anda gunakan untuk membuat API pertama. Mulailah dengan Membangun proxy API pertama Anda.

Cara yang bagus untuk mempelajari tentang proxy API adalah dengan menggunakan contoh seperti yang dijelaskan dalam Menggunakan contoh proxy API.

Pelajari lebih lanjut