Membuat proxy API sederhana

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

Dengan Apigee Edge, Anda dapat dengan cepat mengekspos layanan backend sebagai API. Anda melakukannya dengan membuat proxy API yang menyediakan fasad untuk layanan backend yang ingin diekspos. 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 di masa 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 ringkasan proses pembuatan proxy API.

Membuat proxy API menggunakan UI

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

Edge

Untuk mengakses wizard Create Proxy menggunakan Edge UI:

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

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

Halaman pertama wizard Create Proxy meminta Anda untuk memilih reverse proxy, SOAP service, No Target, atau Proxy bundle untuk menyesuaikan alur wizard.

Edge Klasik (Private Cloud)

Untuk mengakses wizard Create Proxy menggunakan Klasik Edge UI:

  1. Login ke http://ms-ip:9000, dengan ms-ip yang merupakan alamat IP atau nama DNS node Server Pengelolaan.
  2. Pilih APIs > API Proxy di menu navigasi atas.
  3. 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 Create Proxy meminta Anda untuk memilih reverse proxy, SOAP service, No Target, atau Proxy bundle untuk menyesuaikan alur wizard.

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

Jenis Deskripsi
Balik 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 Use OpenAPI Spec untuk menghasilkan proxy dari Spesifikasi OpenAPI yang valid. Untuk informasi selengkapnya tentang opsi ini, lihat Menggunakan Spesifikasi OpenAPI untuk menghasilkan 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 ("tidak ada target"). Mirip dengan membuat reverse proxy untuk layanan HTTP yang dijelaskan sebelumnya, Anda tidak akan menentukan API yang ada saat menentukan detail proxy API.

Klik Use OpenAPI Spec untuk membuat proxy dari spesifikasi OpenAPI yang valid. Untuk informasi selengkapnya tentang opsi ini, lihat Menggunakan Spesifikasi OpenAPI untuk menghasilkan 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.

Upload paket proxy Paket proxy API yang sudah 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 menghasilkan 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 berkemampuan layanan yang dimiliki oleh organisasi Anda. Tombol tersebut juga dapat mengarah ke API yang tersedia secara publik. API atau layanan dapat berada di bawah kendali Anda (misalnya, aplikasi HR internal atau aplikasi Rails di Cloud) atau dapat berupa API atau layanan pihak ketiga (misalnya, Twitter atau Instagram).

Edge

  1. Akses wizard Create Proxy, seperti yang dijelaskan dalam Membuat proxy API menggunakan UI sebelumnya di bagian ini.
  2. Di wizard Create Proxy, klik Reverse proxy (paling umum). Untuk membuat proxy dari Spesifikasi OpenAPI yang ada dan valid, klik Gunakan Spesifikasi OpenAPI. Untuk mengetahui detail tentang opsi ini, lihat Menggunakan Spesifikasi OpenAPI untuk menghasilkan proxy di bawah.
  3. Di halaman Details 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 yang masuk ke proxy API yang tepat.

    CATATAN: Jalur dasar proxy API ditetapkan secara default ke nilai yang ditentukan untuk kolom Name yang dikonversi ke semua huruf kecil.

    URL resource tambahan akan mengikuti jalur dasar. 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 menerapkan 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 bersifat unik.

    Menggunakan karakter pengganti di jalur dasar

    Gunakan satu atau beberapa karakter pengganti /*/ di jalur dasar proxy API agar proxy API 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 Anda perlu membuat proxy API baru untuk mendukung tim baru. Perhatikan bahwa /**/ tidak didukung.

    Deskripsi (Opsional) Deskripsi API.
    Target (API yang Sudah Ada) URL layanan backend yang dipanggil oleh proxy API ini.
  4. Pada halaman Kebijakan umum di wizard, konfigurasikan hal-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 tinggi di bawah Kuota. Lihat Kuota. (Tidak tersedia jika Otorisasi pass-through dipilih.)
    • Penerapan batas monetisasi untuk organisasi yang mendukung monetisasi di bagian Monetisasi. Lihat Menerapkan batas monetisasi di proxy API.
  5. Di halaman Virtual hosts di wizard, pilih host virtual yang akan diikat oleh proxy API saat di-deploy. Untuk informasi selengkapnya, lihat Tentang host virtual.
  6. Pada halaman Summary, pilih lingkungan deployment jika diinginkan, lalu klik Create and deploy.

    Proxy API baru Anda dibuat dan di-deploy di lingkungan yang dipilih.

  7. Klik Edit proxy untuk menampilkan halaman detail proxy API.

Edge Klasik (Private Cloud)

  1. Akses wizard Create Proxy, seperti yang dijelaskan dalam Membuat proxy API menggunakan UI sebelumnya di bagian ini.
  2. Di wizard Build a Proxy, pilih Reverse proxy (paling umum). Untuk membuat proxy dari spesifikasi OpenAPI yang ada dan valid, klik Use OpenAPI. Untuk detail tentang opsi ini, lihat Menggunakan Spesifikasi OpenAPI untuk membuat proxy di bawah.
  3. Klik Next.
  4. Di halaman Details 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 yang masuk ke proxy API yang tepat.

    Catatan: Untuk rekomendasi Apigee terkait pembuatan versi API, lihat Pembuatan Versi di e-book Desain API Web: Link yang Tidak Ada.

    Setelah jalur dasar terdapat URL resource tambahan. Berikut ini 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 lainnya, proxy API ini otomatis dibatalkan deploymentnya saat Anda menyimpannya. Anda harus mengedit jalur dasar sebelum dapat men-deploy ulang jalur tersebut.

    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 Anda perlu membuat proxy API baru untuk mendukung tim baru. Perhatikan bahwa /**/ tidak didukung.

    Catatan: Jalur Dasar Proxy ditetapkan secara default ke nilai yang ditentukan untuk Nama Proxy yang dikonversi ke semua huruf kecil kecuali jika Anda secara eksplisit mengedit konten di kolom Jalur Dasar Proxy.

    API yang sudah ada URL yang dipanggil Platform API atas nama aplikasi yang memanggil API Anda melalui URL proxy API.
    Deskripsi Deskripsi API.
  5. Pada halaman Security di wizard, konfigurasi hal berikut:
  6. Di halaman Virtual Hosts di wizard, pilih host virtual yang akan diikat oleh proxy API saat di-deploy. Untuk informasi selengkapnya, lihat Tentang host virtual.
  7. Pilih lingkungan deployment, lalu klik Build and Deploy
    Kami akan mengirimkan konfirmasi bahwa proxy API baru Anda berhasil dibuat dan di-deploy di lingkungan yang dipilih.
  8. Klik View the <proxy name> proxy in the editor untuk menampilkan halaman detail proxy API tersebut.

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 sekumpulan file di luar 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:

  1. Akses wizard Create Proxy, seperti yang dijelaskan dalam Membuat proxy API menggunakan UI sebelumnya di bagian ini.
  2. Klik Upload paket proxy.
  3. Pada halaman Upload paket proxy di wizard proxy, masukkan informasi berikut.

    Kolom Deskripsi
    Paket ZIP ZIP yang berisi konfigurasi proxy API. Tarik lalu lepas atau klik untuk membuka file.
    Nama Nama yang ditampilkan untuk API Anda. Setelan defaultnya adalah nama file ZIP tanpa ekstensi.
  4. Klik Next.
  5. Di halaman Summary, pilih lingkungan deployment jika diinginkan, lalu klik Create and deploy
    Sebuah konfirmasi akan ditampilkan untuk mengonfirmasi bahwa proxy API baru Anda berhasil dibuat.
  6. Klik Edit proxy untuk menampilkan halaman detail proxy API.

Edge Klasik (Private Cloud)

  1. Akses wizard Create Proxy, seperti yang dijelaskan dalam Membuat proxy API menggunakan UI sebelumnya di bagian ini.
  2. Di wizard Build a Proxy, pilih Paket proxy.
  3. Klik Next.
  4. Pada halaman Detail 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.
  5. 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 dalam organisasi Anda. API yang diekspos oleh proxy API tersedia untuk dipanggil.
  6. Klik View the <proxy name> proxy di editor untuk menampilkan halaman detail proxy API tersebut.
  7. Untuk men-deploy proxy, klik drop-down Deployment, pilih lingkungan tempat Anda ingin men-deploy, dan respons perintah.

Mengekspos layanan web berbasis SOAP sebagai proxy API

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

Menambahkan keamanan

Di halaman Kebijakan umum (Edge) atau Security (classic Edge) pada 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, Platform API menambahkan kebijakan VerifyAPIKey dan kebijakan Tetapkan ke proxy API Anda. Kebijakan VerifyAPIKey memvalidasi kunci API yang ditampilkan dengan meminta aplikasi. Kebijakan BiddingMessage 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 otomatis menambahkan dua kebijakan ke proxy API Anda: satu kebijakan untuk memverifikasi token akses dan kebijakan lainnya untuk menghapus token akses dari pesan sebelum meneruskannya ke layanan backend Anda. Untuk mempelajari cara mendapatkan token akses, lihat OAuth.
Lewati (tanpa otorisasi) Tidak perlu otorisasi. Permintaan diteruskan ke backend tanpa pemeriksaan keamanan 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 kumpulan header HTTP yang digunakan browser dan server Web 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 (classic Edge) pada wizard Create Proxy.

Untuk informasi lebih detail tentang dukungan CORS, termasuk menambahkan dukungan preflight CORS ke proxy, lihat Menambahkan dukungan CORS ke proxy API.

Menggunakan Spesifikasi OpenAPI untuk membuat proxy

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

Apa itu Spesifikasi OpenAPI?

Logo Open API Initiative"Open API Initiative (OAI) berfokus untuk menciptakan, mengembangkan, dan mempromosikan Format Deskripsi API yang netral vendor berdasarkan Spesifikasi Swagger." Untuk informasi lebih lanjut tentang Open API Initiative, lihat https://openapis.org.

Spesifikasi OpenAPI menggunakan format standar untuk mendeskripsikan API RESTful. Ditulis dalam format JSON atau YAML, Spesifikasi OpenAPI dapat dibaca mesin, tetapi juga mudah dibaca dan dipahami oleh manusia. Spesifikasi menjelaskan berbagai elemen API seperti jalur dasarnya, jalur dan kata kerja, header, parameter kueri, operasi, jenis konten, deskripsi respons, dan banyak lagi. 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 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 menghasilkan proxy API. Setelah proxy dihasilkan, Anda dapat menggunakan UI Edge untuk mengembangkannya lebih lanjut dengan menambahkan kebijakan, menerapkan kode kustom, dan sebagainya -- sama seperti proxy Edge lainnya.

Membuat proxy API dari Spesifikasi OpenAPI

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

Di wizard Create Proxy, klik Use OpenAPI Spec dan ikuti wizard untuk membuat proxy 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.

Mengupdate alur di proxy API menggunakan Spesifikasi OpenAPI

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

Untuk memperbarui alur dalam proxy API menggunakan Spesifikasi OpenAPI:

  1. Menambahkan jalur resource baru ke Spesifikasi OpenAPI. Lihat Mengedit Spesifikasi OpenAPI yang ada.
  2. Buka API Proxy di UI, lalu klik tab Develop.
  3. Di Navigator, klik + di samping endpoint Proxy yang ingin diupdate.
    Kotak dialog Alur Bersyarat Baru akan terbuka.
  4. Klik From OpenAPI jika belum dipilih.
    Jika ada beberapa resource di Spesifikasi OpenAPI yang tidak memiliki alur kondisional yang sesuai dalam proxy API, resource tersebut akan tercantum dalam dialog, seperti yang ditampilkan dalam gambar berikut. Resource yang tidak ditampilkan sebagai flow di proxy API saat ini. Contoh ini mencakup /loveapis, /ip, /json, dan /xml.
  5. Pilih setiap resource yang ingin Anda tambahkan alur bersyarat.
  6. Klik Tambahkan.

Alur bersyarat ditambahkan ke proxy API Anda.

Membuat revisi baru proxy API

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

Edge

Untuk membuat revisi proxy API baru menggunakan Edge UI:

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

Edge Klasik (Private Cloud)

Untuk membuat revisi proxy API baru menggunakan UI Classic Edge:

  1. Login ke http://ms-ip:9000, dengan ms-ip yang merupakan alamat IP atau nama DNS node Server Pengelolaan.
  2. Pilih APIs > API Proxy di menu navigasi atas.
  3. Klik proxy API dalam daftar yang ingin Anda salin.
  4. 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 Edge UI:

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

Edge Klasik (Private Cloud)

Untuk menyalin proxy API menggunakan UI Edge Klasik:

  1. Login ke http://ms-ip:9000, dengan ms-ip yang merupakan alamat IP atau nama DNS node Server Pengelolaan.
  2. Pilih APIs > API Proxy di menu navigasi atas.
  3. Klik proxy API dalam daftar yang ingin Anda salin.
  4. Pilih Project > Save as New API Proxy.
  5. Pada dialog Save as New Proxy, masukkan nama proxy API baru.
  6. 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 informasi selengkapnya, lihat Mendownload proxy API.

Membuat proxy API menggunakan API

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