Membuat proxy API

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Baca dokumentasi Apigee Edge.

Catatan: Di lingkungan yang diaktifkan untuk deployment arsip, Anda tidak dapat mengembangkan proxy API menggunakan UI Apigee, API, atau gcloud. Guna 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.

Apigee di Konsol Cloud

Untuk membuat proxy di Apigee di Cloud Console:

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

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

2. Di panel navigasi sebelah 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 nilai berikut:
   • Nama proxy: Masukkan nama untuk proxy, seperti myproxy.
   • Jalur Dasar: Secara 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 ini untuk mencocokkan dan mengarahkan permintaan masuk ke proxy API yang sesuai.
   • Deskripsi (Opsional): Masukkan deskripsi untuk proxy API baru Anda, seperti "Menguji Apigee dengan proxy sederhana".
   • Target (Existing API): 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. Token ini tidak memerlukan kunci API atau token akses.
   • Klik Next.
6. Klik Next.
7. Deploy (opsional):
   • Lingkungan deployment: Opsional. Gunakan kotak centang untuk memilih satu atau beberapa lingkungan tempat Anda akan men-deploy proxy. Jika Anda memilih untuk tidak men-deploy proxy pada tahap ini, kosongkan kolom Deployment environment. Anda dapat men-deploy proxy kapan saja.
   • Akun Layanan: Opsional. Tambahkan akun layanan ke deployment Anda agar proxy dapat mengakses layanan Google Cloud, seperti yang ditentukan dalam peran dan izin akun layanan.
8. Klik Create.

Apigee membuat proxy baru dan menampilkan ringkasan detail proxy dalam tampilan Ringkasan proxy.

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

Apigee Klasik

Untuk membuat proxy API sederhana di UI Apigee klasik:

1. Login ke UI Apigee.
2. Klik API Proxy 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 ini kosong.

4. Klik Create New.

   Wizard Create Proxy akan dimulai.

5. Klik Reverse proxy (paling umum).

   

   Halaman Detail proxy akan ditampilkan.

6. Konfigurasikan proxy Anda dengan setelan berikut:
   • Nama: Masukkan getstarted. Jika proxy dengan nama ini sudah ada, pilih nama lain.
   • Jalur Dasar: Biarkan ditetapkan ke /getstarted. Jalur Dasar adalah bagian dari URL yang digunakan untuk membuat permintaan ke API Anda. Apigee menggunakan URL ini untuk mencocokkan dan mengarahkan permintaan masuk ke proxy API yang sesuai.
   • Deskripsi (Opsional): Masukkan deskripsi untuk proxy API baru Anda, seperti Get started API proxy.
   • Target (Existing API): 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. Token ini tidak memerlukan kunci API atau token akses.

   Detail proxy API Anda akan terlihat seperti berikut:

   

7. Klik Next.
8. Di tampilan Common policies, di bagian Security: Authorization, pilih Pass through (no authorization).

   

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

    

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

    Karena alasan ini, 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 dalam Langkah berikutnya.

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

    

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

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

API Apigee

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 menjadi seperti berikut: A-Za-z0-9._\-$ %

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

• Setel parameter kueri action ke import
• Setel header Content-type ke multipart/form-data
• Meneruskan 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 Anda 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, 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 tentang variabel lingkungan yang digunakan, lihat Menetapkan variabel lingkungan untuk permintaan Apigee API.

Berikut ini 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 pembuatan 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 platform Apigee lainnya, seperti yang dijelaskan dalam Memahami API dan proxy API.
• Deploy ke cluster Anda, seperti yang dijelaskan dalam Men-deploy proxy API.