Membuat proxy API

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat dokumentasi Apigee Edge.

Catatan: Di lingkungan yang diaktifkan untuk deployment arsip, Anda tidak dapat mengembangkan proxy API menggunakan UI, API, atau gcloud Apigee. Untuk mengembangkan proxy API untuk deployment arsip menggunakan Apigee di VS Code,lihat Mengembangkan proxy API menggunakan Apigee di VS Code.

Buat proxy di UI Apigee, atau menggunakan API, seperti yang dijelaskan di bagian berikut.

Kolom utama proxy API

Ikuti panduan ini saat membuat proxy API:

Kolom	Deskripsi
Nama proxy API	Nama yang ditampilkan untuk API Anda. Tentukan karakter alfanumerik, tanda hubung (-), atau garis bawah (_). Catatan: Nama proxy API tidak boleh sama dengan nama proxy API apa pun di organisasi yang dapat di-deploy ke lingkungan dengan deployment Proxy diaktifkan.
Jalur dasar proxy API	Fragmen URI yang muncul setelah alamat http://[host] atau https://[host] proxy API Anda. Apigee menggunakan URI jalur dasar untuk mencocokkan dan merutekan pesan permintaan yang masuk ke proxy API yang sesuai. 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, Apigee 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 membuat proxy API Anda tahan terhadap masa depan. Kami mengizinkan spesifikasi satu karakter pengganti * di antara dua karakter garis miring /: /*/. 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. Anda dapat mengganti token dalam jumlah berapa pun di jalur dasar dengan mengikuti pola ini. Pola lain, termasuk /**, /something*, atau /*something, tidak didukung.
Deskripsi	(Opsional). Deskripsi untuk proxy API.
URL target/Target backend	URL (termasuk HTTP atau HTTPS) layanan backend yang dipanggil oleh proxy API ini.

Langkah-langkah untuk membuat proxy API

Untuk membuat proxy API menggunakan UI atau API:

Apigee di konsol Cloud

Untuk membuat proxy di Apigee di konsol Cloud:

1. Buka UI Apigee di Cloud Console di browser.
   Catatan: Jika Anda melihat halaman Selamat datang di Pengelolaan API Apigee, Anda harus menyediakan organisasi Apigee sebelum melanjutkan lebih lanjut.

   Setelah Anda menyediakan Apigee, tutup UI dan buka kembali UI Apigee di konsol Cloud.

2. Di panel navigasi kiri, klik Pengembangan proxy > Proxy API.
3. Di panel API Proxies, klik + Create.
4. Di panel Create a proxy, pada bagian Proxy template, pilih Reverse proxy (Most common).
5. Di bagian Proxy details, masukkan hal berikut:
   • Nama proxy: Masukkan nama untuk proxy, seperti myproxy.
   • Base Path: Otomatis ditetapkan ke nilai yang Anda masukkan untuk Proxy name. Jalur Dasar adalah bagian dari URL yang digunakan untuk membuat permintaan ke API Anda. Apigee menggunakan URL untuk mencocokkan dan merutekan permintaan masuk ke proxy API yang sesuai.
   • Deskripsi (Opsional): Masukkan deskripsi untuk proxy API baru Anda, seperti "Menguji Apigee dengan proxy sederhana".
   • Target (API yang Ada): Masukkan https://mocktarget.apigee.net. Ini menentukan URL target yang dipanggil Apigee pada permintaan ke proxy API. Layanan mocktarget dihosting di Apigee dan menampilkan data sederhana. Anda tidak memerlukan kunci API atau token akses.
   • Klik Berikutnya.
6. Deploy (opsional):
   • Lingkungan deployment: Opsional. Gunakan kotak centang untuk memilih satu atau beberapa lingkungan tempat proxy akan di-deploy. Jika Anda memilih untuk tidak men-deploy proxy pada tahap ini, biarkan kolom Deployment environments kosong. Anda dapat men-deploy proxy nanti.
   • Akun Layanan: Opsional. Lampirkan akun layanan ke deployment Anda untuk mengaktifkan proxy agar dapat mengakses layanan Google Cloud, seperti yang ditentukan dalam peran dan izin akun layanan.
7. Klik Create.

Apigee akan membuat proxy baru dan menampilkan ringkasan detail proxy di tampilan Ringkasan proxy.

Jika Anda memilih untuk men-deploy proxy, bagian Deployments akan menampilkan nomor Revision, yaitu 1 saat Anda pertama kali men-deploy. Kolom Status menampilkan lingkungan tempat proxy di-deploy dengan indikator status hijau.

Apigee Klasik

Untuk membuat proxy API sederhana di UI Apigee klasik:

1. Login ke UI Apigee.
2. Klik API Proxies di tampilan utama.
3. Dari menu drop-down Environment, pilih lingkungan tempat Anda ingin membuat proxy API baru.

   UI hybrid menampilkan daftar proxy API untuk lingkungan tersebut. Jika Anda belum membuat proxy, daftar akan kosong.

4. Klik Buat Baru.

   Wizard Create Proxy akan dimulai.

5. Klik Reverse proxy (paling umum).

   

   Halaman Proxy details akan ditampilkan.

6. Konfigurasikan proxy dengan setelan berikut:
   • Nama: Masukkan getstarted. Jika proxy sudah ada dengan nama ini, pilih nama yang berbeda.
   • Jalur Dasar: Biarkan setelan ini ditetapkan ke /getstarted. Jalur Dasar adalah bagian dari URL yang digunakan untuk membuat permintaan ke API Anda. Apigee menggunakan URL untuk mencocokkan dan merutekan permintaan masuk ke proxy API yang sesuai.
   • Deskripsi (Opsional): Masukkan deskripsi untuk proxy API baru Anda, seperti Get started API proxy.
   • Target (API yang Ada): Masukkan https://mocktarget.apigee.net. Ini menentukan URL target yang dipanggil Apigee pada permintaan ke proxy API. Layanan mocktarget dihosting di Apigee dan menampilkan data sederhana. Anda tidak memerlukan kunci API atau token akses.

   Detail proxy API Anda akan terlihat seperti berikut:

   

7. Klik Berikutnya.
8. Di tampilan Kebijakan umum, pada bagian Keamanan: Otorisasi, pilih Pass through (tanpa otorisasi).

   

9. Klik Berikutnya.
10. Di halaman Summary, pilih lingkungan deployment, jika diinginkan, lalu klik Create and deploy.

    

    Catatan: Jika Anda tidak memilih lingkungan di bawah Deployment Opsional, tombol di kanan bawah hanya berlabel Buat.
    Catatan: Setelah men-deploy revisi proxy API, Anda tidak dapat mengeditnya. Untuk mengedit proxy API, Anda harus membuat dan men-deploy revisi baru.

    Oleh karena itu, Anda dapat memilih untuk membuat proxy API tanpa men-deploy-nya ke lingkungan apa pun. Anda dapat mengedit proxy API dan men-deploy proxy API nanti, seperti yang dijelaskan di Langkah berikutnya.

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

    

11. Klik Edit proxy untuk menampilkan tab Ringkasan di Editor Proxy.

Dalam daftar proxy API, status deployment proxy API getstarted berwarna hijau untuk lingkungan test.

Apigee API

Buat proxy API di organisasi Apigee Anda dengan mengeluarkan permintaan POST ke resource berikut:

https://apigee.googleapis.com/v1/organizations/$ORG/apis

Anda harus menentukan nama proxy API menggunakan parameter kueri name. Batasi karakter yang digunakan dalam nama ke karakter berikut: A-Za-z0-9._\-$ %

Secara opsional, Anda dapat mengimpor paket konfigurasi proxy API dengan melakukan langkah-langkah berikut:

• Tetapkan parameter kueri action ke import
• Tetapkan header Content-type ke multipart/form-data
• Teruskan nama paket konfigurasi proxy API di sistem file lokal Anda

Contoh berikut menunjukkan cara membuat proxy API dengan mengimpor paket konfigurasi proxy API (helloworld-config.zip) di sistem file lokal menggunakan API.

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apis?name=helloworld&action=import" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: multipart/form-data" \
  -F "file=@helloworld-config.zip"

Dengan $TOKEN ditetapkan ke token akses OAuth 2.0 Anda, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0. Untuk mengetahui informasi tentang opsi curl yang digunakan dalam contoh ini, lihat Menggunakan curl. Untuk deskripsi variabel lingkungan yang digunakan, lihat Menetapkan variabel lingkungan untuk permintaan Apigee API.

Berikut adalah contoh output respons:

{
  "basepaths": [
    "/helloworld"
  ],
  "configurationVersion": {
    "majorVersion": 4
  },
  "createdAt": "1559145292799",
  "displayName": "helloworld",
  "entityMetaDataAsProperties": {
    "bundle_type": "zip",
    "subType": "Proxy",
    "lastModifiedAt": "1559145292799",
    "createdAt": "1559145292799"
  },
  "lastModifiedAt": "1559145292799",
  "name": "helloworld",
  "policies": [
    "verify-api-key",
    "remove-query-param-apikey",
    "OAuth-v20-1"
  ],
  "proxies": [
    "default"
  ],
  "proxyEndpoints": [
    "default"
  ],
  "resourceFiles": {},
  "targetEndpoints": [
    "default"
  ],
  "targets": [
    "default"
  ],
  "type": "Application",
  "revision": "1",
  "description": "Hello world"
}

Untuk informasi selengkapnya tentang cara membuat proxy API, lihat metode apis.create di Apigee API. Untuk melihat semua metode yang tersedia untuk proxy API, lihat API proxy API.

Langkah berikutnya

Setelah membuat proxy API sederhana, Anda biasanya melakukan salah satu hal berikut:

• Tambahkan kebijakan, keamanan, dan fitur lain dari platform Apigee, seperti yang dijelaskan dalam Memahami API dan proxy API.
• Deploy ke cluster Anda, seperti yang dijelaskan dalam Men-deploy proxy API.