Halaman ini diterjemahkan oleh Cloud Translation API.

Membuat proxy API sederhana

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

Apigee Edge memungkinkan Anda mengekspos layanan backend sebagai API dengan cepat. Anda melakukannya dengan membuat proxy API yang menyediakan fasad untuk layanan backend yang ingin Anda ekspos. Anda hanya perlu memberikan alamat jaringan untuk layanan backend, beserta beberapa informasi yang digunakan Edge untuk membuat proxy API yang diekspos kepada developer.

Proxy API memisahkan implementasi layanan backend Anda dari API yang digunakan developer. Hal ini melindungi developer dari perubahan mendatang pada layanan backend Anda. Saat Anda mengupdate layanan backend, developer, yang terisolasi dari perubahan tersebut, dapat terus memanggil API tanpa gangguan.

Tonton video ini untuk mengetahui ringkasan proses pembuatan proxy API.

Membuat proxy API menggunakan UI

Cara termudah untuk membuat proxy API adalah menggunakan wizard Create Proxy.

Edge

Untuk mengakses wizard Buat Proxy menggunakan UI Edge:

Login ke apigee.com/edge.
Pilih Develop > API Proxies di menu navigasi sebelah kiri.
Klik +Proxy.

Wizard Create Proxy menampilkan dan memandu Anda melalui langkah-langkah untuk membuat dan menambahkan fitur minimal ke proxy API.

Halaman pertama wizard Buat Proxy yang meminta Anda untuk memilih paket reverse proxy, SOAP, No Target, atau Proxy untuk menyesuaikan alur wizard.

Edge Klasik (Private Cloud)

Untuk mengakses wizard Create Proxy menggunakan UI Classic Edge:

Login ke http://ms-ip:9000, dengan ms-ip adalah alamat IP atau nama DNS node Server Pengelolaan.
Pilih APIs > API Proxies di menu navigasi atas.
Klik + API Proxy.

Wizard Create Proxy menampilkan dan memandu Anda melalui langkah-langkah untuk membuat dan menambahkan fitur minimal ke proxy API.

Halaman pertama wizard Buat Proxy yang meminta Anda memilih reverse proxy, layanan SOAP, Tidak ada Target, atau paket Proxy untuk menyesuaikan alur wizard.

Halaman pertama wizard memungkinkan Anda membuat proxy API dari sumber berikut:

Jenis	Deskripsi
Reverse proxy (paling umum)	Proxy API yang merutekan permintaan masuk ke layanan backend HTTP yang ada. Dapat berupa JSON atau XML API. Lihat Membuat reverse proxy untuk layanan HTTP nanti di bagian ini. Klik Gunakan Spesifikasi OpenAPI untuk membuat proxy dari Spesifikasi OpenAPI yang valid. Untuk informasi selengkapnya tentang opsi ini, lihat Menggunakan Spesifikasi OpenAPI untuk membuat proxy nanti di bagian ini.
Layanan SOAP	Proxy API yang dihasilkan dari file WSDL. Lihat Mengekspos layanan web berbasis SOAP sebagai proxy API.
Tidak ada target	Proxy API tanpa backend API ("tanpa target"). Mirip dengan membuat reverse proxy untuk layanan HTTP yang dijelaskan sebelumnya, kecuali Anda tidak akan menentukan API yang ada saat menentukan detail proxy API. Klik Gunakan Spesifikasi OpenAPI untuk membuat proxy dari spesifikasi OpenAPI yang valid. Untuk informasi selengkapnya tentang opsi ini, lihat Menggunakan Spesifikasi OpenAPI untuk membuat proxy nanti di bagian ini.
Target yang dihosting	Proxy API yang merutekan ke aplikasi Node.js yang di-deploy ke lingkungan Target yang Dihosting. Lihat Ringkasan Target yang Dihosting.
Mengupload paket proxy	Paket proxy API yang ada (misalnya, salah satu contoh proxy API yang tersedia di GitHub.) Lihat Mengimpor proxy API dari paket proxy API.

Bagian berikut menjelaskan cara membuat proxy API menggunakan setiap sumber.

Membuat reverse proxy untuk layanan HTTP

Edge membuat reverse proxy berdasarkan dua informasi:

URL layanan backend
Jalur URI yang secara unik mengidentifikasi API yang akan diekspos oleh proxy API ke aplikasi konsumen

URL layanan backend biasanya mewakili aplikasi yang mengaktifkan layanan dan dimiliki oleh organisasi Anda. URL ini juga dapat mengarah ke API yang tersedia untuk publik. API atau layanan dapat berada di bawah kontrol Anda (misalnya, aplikasi HR internal atau aplikasi Rails di Cloud) atau dapat berupa API atau layanan pihak ketiga (misalnya, Twitter atau Instagram).

Edge

Akses wizard Create Proxy, seperti yang dijelaskan di Membuat proxy API menggunakan UI sebelumnya di bagian ini.
Di wizard Create Proxy, klik Reverse proxy (most common). Untuk menghasilkan proxy dari Spesifikasi OpenAPI yang valid dan ada, klik Gunakan Spesifikasi OpenAPI. Untuk mengetahui detail tentang opsi ini, lihat Menggunakan Spesifikasi OpenAPI untuk membuat proxy di bawah.

Di halaman Details pada wizard, masukkan informasi berikut.

Kolom	Deskripsi
Nama	Nama yang ditampilkan untuk API Anda. Tentukan karakter alfanumerik, tanda hubung (-), atau garis bawah (_).
Jalur dasar	Fragmen URI yang muncul setelah alamat http(s)://[host] proxy API Anda. Edge menggunakan URI jalur dasar untuk mencocokkan dan merutekan pesan permintaan masuk ke proxy API yang sesuai. CATATAN: Jalur dasar proxy API secara default menggunakan nilai yang ditentukan untuk kolom `Name` yang dikonversi ke semua huruf kecil. Setelah jalur dasar, ada URL resource tambahan. Berikut adalah struktur URL lengkap yang akan digunakan klien untuk memanggil proxy API Anda: `https://[host]/base_path/conditional_flow_path` CATATAN: Jalur dasar harus unik; Anda tidak dapat men-deploy dua proxy API dengan jalur dasar yang sama. Jika Anda mengedit proxy API yang di-deploy dan menetapkan jalur dasar ke nilai yang sama dengan jalur dasar proxy API lain, Edge akan otomatis membatalkan deployment proxy API saat Anda menyimpannya. Sebelum dapat men-deploy ulang proxy API, Anda harus mengedit jalur dasar agar unik. Menggunakan karakter pengganti di jalur dasar Gunakan satu atau beberapa karakter pengganti `//` di jalur dasar proxy API untuk mempersiapkan proxy API Anda di masa mendatang. Misalnya, jalur dasar `/team//members` memungkinkan klien memanggil `https://[host]/team/blue/members` dan `https://[host]/team/green/members` tanpa Anda perlu membuat proxy API baru untuk mendukung tim baru. Perlu diperhatikan bahwa `/**/` tidak didukung.
Deskripsi	(Opsional) Deskripsi API.
Target (API yang Sudah Ada)	URL layanan backend yang dipanggil oleh proxy API ini.

Di halaman Kebijakan umum wizard, konfigurasikan hal berikut:
- Persyaratan otorisasi keamanan di bagian Keamanan: Otorisasi. Lihat Menambahkan keamanan nanti di bagian ini.
- Dukungan untuk Cross-origin resource sharing (CORS) di bagian Security: Browser. Lihat Menambahkan dukungan untuk CORS nanti di bagian ini.
- Kuota untuk melindungi layanan backend Anda dari traffic yang tinggi di bagian Kuota. Lihat Kuota. (Tidak tersedia jika Otorisasi pass-through dipilih.)
- Penerapan batas monetisasi untuk organisasi yang mengaktifkan monetisasi di bagian Monetisasi. Lihat Menerapkan batas monetisasi pada proxy API.
Di halaman Virtual hosts pada wizard, pilih host virtual yang akan diikat oleh proxy API saat di-deploy. Untuk mengetahui informasi selengkapnya, lihat Tentang host virtual.
Di halaman Summary, pilih lingkungan deployment, jika diinginkan, lalu klik Create and deploy.
Proxy API baru Anda dibuat dan di-deploy di lingkungan yang dipilih.
Klik Edit proxy untuk menampilkan halaman detail untuk proxy API.

Edge Klasik (Private Cloud)

Akses wizard Create Proxy, seperti yang dijelaskan di Membuat proxy API menggunakan UI sebelumnya di bagian ini.
Di wizard Build a Proxy, pilih Reverse proxy (most common). Untuk membuat proxy dari spesifikasi OpenAPI yang ada dan valid, klik Gunakan OpenAPI. Untuk mengetahui detail tentang opsi ini, lihat Menggunakan Spesifikasi OpenAPI untuk membuat proxy di bawah.
Klik Berikutnya.

Di halaman Details pada wizard, masukkan informasi berikut.

Kolom	Deskripsi
Nama Proxy	Nama yang ditampilkan untuk API Anda.
Jalur Dasar Proxy	Jalur Dasar Proxy adalah fragmen URI setelah alamat http(s)://[host] proxy API Anda. Edge menggunakan URI Jalur Dasar untuk mencocokkan dan merutekan pesan permintaan masuk ke proxy API yang sesuai. Catatan: Untuk rekomendasi Apigee tentang pembuatan versi API, lihat Pembuatan Versi di e-book Desain Web API: Link yang Hilang. Setelah jalur dasar, ada URL resource tambahan. Berikut adalah struktur URL lengkap yang akan digunakan klien untuk memanggil proxy API Anda: `https://[host]/base_path/conditional_flow_path` Catatan: Jalur dasar harus unik. Jika nanti Anda mengedit proxy ini dan menetapkan jalur dasarnya agar sama dengan proxy API lain, proxy API ini akan otomatis di-undeploy saat Anda menyimpannya. Anda harus mengedit jalur dasar sebelum dapat men-deploy ulang. Menggunakan karakter pengganti di jalur dasar Anda dapat menggunakan satu atau beberapa karakter pengganti `//` di jalur dasar proxy API agar proxy Anda siap menghadapi masa depan. Misalnya, jalur dasar `/team//members` memungkinkan klien memanggil `https://[host]/team/blue/members` dan `https://[host]/team/green/members` tanpa perlu membuat proxy API baru untuk mendukung tim baru. Perhatikan bahwa // tidak didukung. Catatan**: Jalur Dasar Proxy secara default menggunakan nilai yang ditentukan untuk Nama Proxy yang dikonversi menjadi huruf kecil kecuali jika Anda secara eksplisit mengedit konten di kolom Jalur Dasar Proxy.
API yang Ada	URL yang dipanggil Platform API atas nama aplikasi yang memanggil API Anda melalui URL proxy API.
Deskripsi	Deskripsi API.

Di halaman Keamanan pada wizard, konfigurasikan hal berikut:
- Persyaratan autentikasi keamanan. Lihat Menambahkan keamanan nanti di bagian ini.
- Dukungan untuk Cross-origin resource sharing (CORS). Lihat Menambahkan dukungan untuk CORS nanti di bagian ini.
Di halaman Virtual Hosts pada wizard, pilih host virtual yang akan diikat oleh proxy API saat di-deploy. Untuk mengetahui informasi selengkapnya, lihat Tentang host virtual.
Pilih lingkungan deployment, lalu klik Build and Deploy
Acknowledgment akan dikirim untuk mengonfirmasi bahwa proxy API baru Anda berhasil dibuat dan di-deploy di lingkungan yang dipilih.
Klik Lihat proxy <nama proxy> di editor untuk menampilkan halaman detail proxy API.

Mengimpor proxy API dari paket proxy API

Sering kali Anda menentukan proxy API sebagai kumpulan file XML, beserta file pendukung lainnya. Dengan menentukan proxy API sebagai kumpulan file eksternal ke Edge, Anda dapat mengelolanya dalam sistem kontrol sumber, lalu mengimpornya ke Edge untuk pengujian dan deployment.

Tonton video ini untuk mempelajari cara membuat dan mengimpor proxy API dari paket proxy API.

Edge

Untuk mengimpor proxy API dari paket proxy API:

Akses wizard Create Proxy, seperti yang dijelaskan di Membuat proxy API menggunakan UI sebelumnya di bagian ini.
Klik Upload paket proxy.

Di halaman Upload proxy bundle di wizard proxy, masukkan informasi berikut.

Kolom	Deskripsi
Paket ZIP	File ZIP yang berisi konfigurasi proxy API. Tarik lalu lepas atau klik untuk membuka file.
Nama	Nama yang ditampilkan untuk API Anda. Secara default, nama file ZIP tanpa ekstensi.

Klik Berikutnya.
Di halaman Ringkasan, pilih lingkungan deployment, jika diinginkan, lalu klik Buat dan deploy
Konfirmasi akan ditampilkan untuk mengonfirmasi bahwa proxy API baru Anda berhasil dibuat.
Klik Edit proxy untuk menampilkan halaman detail untuk proxy API.

Edge Klasik (Private Cloud)

Akses wizard Create Proxy, seperti yang dijelaskan di Membuat proxy API menggunakan UI yang sebelumnya di bagian ini.
Di wizard Build a Proxy, pilih Proxy bundle.
Klik Berikutnya.

Di halaman Details di wizard proxy, masukkan informasi berikut.

Kolom	Deskripsi
Paket ZIP	Klik Choose File dan buka file ZIP yang berisi konfigurasi proxy API.
Nama Proxy	Nama yang ditampilkan untuk API Anda.

Tinjau informasi build, lalu klik Build.
Jika berhasil, pesan akan ditampilkan dan Edge akan otomatis men-deploy proxy API yang diimpor ke lingkungan yang dipilih di organisasi Anda. API yang diekspos oleh proxy API tersedia untuk dipanggil.
Klik Lihat proxy <nama proxy> di editor untuk menampilkan halaman detail proxy API.
Untuk men-deploy proxy, klik drop-down Deployment, pilih lingkungan tempat Anda ingin men-deploy, lalu tanggapi perintah.

Mengekspos layanan web berbasis SOAP sebagai proxy API

Di wizard Create Proxy, klik SOAP Service, lalu ikuti wizard untuk membuat proxy pass-through atau berbasis REST untuk layanan SOAP. Untuk mengetahui detailnya, lihat Mengekspos layanan SOAP sebagai proxy API.

Menambahkan keamanan

Di halaman Kebijakan umum (Edge) atau Keamanan (Edge Klasik) di wizard Create Proxy, pilih jenis otorisasi keamanan yang ingin Anda tambahkan. Tabel berikut merangkum opsi yang tersedia:

Otorisasi keamanan	Deskripsi
Kunci API	Menambahkan verifikasi kunci API sederhana ke proxy API yang Anda tentukan. Sebagai respons, API Platform akan menambahkan kebijakan VerifyAPIKey dan kebijakan AssignMessage ke proxy API Anda. Kebijakan VerifyAPIKey memvalidasi kunci API yang ditampilkan dengan meminta aplikasi. Kebijakan AssignMessage menghapus kunci API, yang disediakan dalam panggilan API sebagai parameter kueri, dari permintaan yang diteruskan ke server backend.
OAuth 2.0	Menambahkan autentikasi berbasis OAuth 2.0 ke proxy API Anda. Apigee Edge secara otomatis menambahkan dua kebijakan ke proxy API Anda: satu kebijakan untuk memverifikasi token akses dan kebijakan lain untuk menghapus token akses dari pesan sebelum meneruskannya ke layanan backend Anda. Untuk mempelajari cara mendapatkan token akses, lihat OAuth.
Teruskan (tanpa otorisasi)	Otorisasi tidak diperlukan. Permintaan diteruskan ke backend tanpa pemeriksaan keamanan apa pun di Apigee Edge.

Menambahkan dukungan untuk CORS

CORS (Cross-origin resource sharing) adalah mekanisme standar yang memungkinkan browser Web membuat permintaan langsung ke domain lain. Standar CORS menentukan sekumpulan header HTTP yang digunakan browser Web dan server untuk mengimplementasikan komunikasi lintas-domain.

Anda dapat menambahkan dukungan untuk CORS ke API dengan memilih Add CORS headers di halaman Common policies (Edge) atau Security (Klasik Edge) di wizard Create Proxy.

Untuk informasi yang lebih mendetail tentang dukungan CORS, termasuk menambahkan dukungan pra-penerbangan CORS ke proxy, lihat Menambahkan dukungan CORS ke proxy API.

Menggunakan Spesifikasi OpenAPI untuk membuat proxy

Bagian ini membahas opsi Use OpenAPI yang tersedia untuk membuat jenis proxy API berikut dari Spesifikasi OpenAPI: reverse, Node.js, atau tanpa target.

Apa itu Spesifikasi OpenAPI?

Logo Open API Initiative "Open API Initiative (OAI) berfokus pada pembuatan, pengembangan, dan promosi Format Deskripsi API yang netral vendor berdasarkan Spesifikasi Swagger". Untuk informasi selengkapnya tentang Open API Initiative, lihat https://openapis.org.

Spesifikasi OpenAPI menggunakan format standar untuk mendeskripsikan RESTful API. Ditulis dalam format JSON atau YAML, Spesifikasi OpenAPI dapat dibaca oleh mesin, tetapi juga mudah dibaca dan dipahami manusia. Spesifikasi ini menjelaskan elemen API tersebut seperti jalur dasar, jalur dan kata kerja, header, parameter kueri, operasi, jenis konten, deskripsi respons, dan lainnya. Selain itu, Spesifikasi OpenAPI biasanya digunakan untuk membuat dokumentasi API.

Berikut adalah fragmen dari Spesifikasi OpenAPI yang menjelaskan layanan target tiruan Apigee, http://mocktarget.apigee.net. Untuk mengetahui informasi selengkapnya, lihat https://github.com/apigee/api-platform-samples/tree/master/default-proxies/helloworld/openapi.

openapi: 3.0.0
info:
  description: OpenAPI Specification for the Apigee mock target service endpoint.
  version: 1.0.0
  title: Mock Target API
paths:
  /:
    get:
      summary: View personalized greeting
      operationId: View a personalized greeting
      description: View a personalized greeting for the specified or guest user.
      parameters:
        - name: user
          in: query
          description: Your user name.
          required: false
          schema:
            type: string
      responses:
        "200":
          description: Success
  /help:
    get:
      summary: Get help
      operationId: Get help
      description: View help information about available resources in HTML format.
      responses:
        "200":
          description: Success
...

Melalui wizard Create Proxy, Anda dapat mengimpor Spesifikasi OpenAPI dan menggunakannya untuk membuat proxy API. Setelah proxy dibuat, Anda dapat menggunakan UI Edge untuk mengembangkannya lebih lanjut dengan menambahkan kebijakan, menerapkan kode kustom, dan sebagainya -- seperti proxy Edge lainnya.

Membuat proxy API dari Spesifikasi OpenAPI

Buat proxy API dari Spesifikasi OpenAPI. Hanya dengan beberapa klik, Anda akan memiliki proxy API dengan jalur, parameter, alur kondisional, dan endpoint target yang dibuat secara otomatis. Kemudian, Anda dapat menambahkan fitur seperti keamanan OAuth, pembatasan kapasitas, dan penyimpanan dalam cache.

Di wizard Create Proxy, klik Use OpenAPI Spec dan ikuti wizard untuk membuat proxy target terbalik atau tanpa target dari Spesifikasi OpenAPI. Untuk mengetahui detailnya, lihat Membuat proxy API dari Spesifikasi OpenAPI.

Tonton video ini untuk mempelajari cara membuat proxy API dari Spesifikasi OpenAPI.

Memperbarui alur di proxy API menggunakan Spesifikasi OpenAPI

Setelah membuat proxy API dari Spesifikasi OpenAPI, jika Anda mengubah spesifikasi untuk menambahkan jalur resource tambahan, Anda dapat menggunakan spesifikasi tersebut untuk menambahkan alur bersyarat terkait ke proxy API.

Untuk memperbarui alur di proxy API menggunakan Spesifikasi OpenAPI:

Tambahkan jalur resource baru ke Spesifikasi OpenAPI. Lihat Mengedit Spesifikasi OpenAPI yang ada.
Buka Proxy API di UI dan klik tab Develop.
Di Navigator, klik + di samping endpoint Proxy yang ingin Anda perbarui.
Kotak dialog Alur Bersyarat Baru akan terbuka.
Klik Dari OpenAPI jika belum dipilih.
Jika ada resource dalam Spesifikasi OpenAPI yang tidak memiliki alur kondisional terkait dalam proxy API, resource tersebut akan dicantumkan dalam dialog, seperti yang ditampilkan dalam gambar berikut.
Pilih setiap resource yang ingin Anda tambahkan alur kondisional.
Klik Tambahkan.

Alur kondisional ditambahkan ke proxy API Anda.

Membuat revisi baru dari proxy API

Buat revisi baru proxy API, seperti yang dijelaskan di bawah.

Edge

Untuk membuat revisi baru proxy API menggunakan UI Edge:

Login ke apigee.com/edge.
Pilih Develop > API Proxies di menu navigasi sebelah kiri.
Klik proxy API dalam daftar yang ingin Anda salin.
Pilih Project > Save as New Revision.

Edge Klasik (Private Cloud)

Untuk membuat revisi baru proxy API menggunakan UI Edge Klasik:

Login ke http://ms-ip:9000, dengan ms-ip adalah alamat IP atau nama DNS node Server Pengelolaan.
Pilih APIs > API Proxies di menu navigasi atas.
Klik proxy API dalam daftar yang ingin Anda salin.
Pilih Project > Save as New Revision.

Menyalin proxy API

Salin proxy API yang ada ke proxy API baru, seperti yang dijelaskan di bawah.

Edge

Untuk menyalin proxy API menggunakan UI Edge:

Login ke apigee.com/edge.
Pilih Develop > API Proxies di menu navigasi sebelah kiri.
Klik proxy API dalam daftar yang ingin Anda salin.
Pilih Project > Save as New API Proxy.
Pada dialog Save as New Proxy, masukkan nama proxy API baru.
Klik Tambahkan.

Edge Klasik (Private Cloud)

Untuk menyalin proxy API menggunakan UI Edge Klasik:

Login ke http://ms-ip:9000, dengan ms-ip adalah alamat IP atau nama DNS node Server Pengelolaan.
Pilih APIs > API Proxies di menu navigasi atas.
Klik proxy API dalam daftar yang ingin Anda salin.
Pilih Project > Save as New API Proxy.
Pada dialog Save as New Proxy, masukkan nama proxy API baru.
Klik Tambahkan.

Mencadangkan proxy API

Anda dapat mencadangkan proxy API yang ada sebagai kumpulan file XML dalam paket proxy API. Setelah diekspor ke paket, Anda dapat mengimpor proxy API ke proxy baru, seperti yang dijelaskan dalam Mengimpor proxy API dari paket proxy API sebelumnya di bagian ini. Untuk mengetahui informasi selengkapnya, lihat Mendownload proxy API.

Membuat proxy API menggunakan API

Untuk membuat proxy API menggunakan API, lihat API proxy API.