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 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 Konsol Cloud:

1. Buka UI Apigee di Konsol Cloud di browser.
   Catatan: Jika Anda melihat halaman Welcome to Apigee API Management, Anda harus menyediakan organisasi Apigee Anda sebelum melanjutkan.

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

2. Di panel navigasi sebelah kiri, klik Proxy development > Proxy API.
3. Di panel API Proxies, klik + Create.
4. Di panel Create a proxy, di bagian Proxy template, pilih Reverse proxy (Paling umum).
5. Di bagian Detail proxy, masukkan informasi berikut:
   • Nama proxy: Masukkan nama untuk proxy, seperti myproxy.
   • Jalur Dasar: Secara otomatis ditetapkan ke nilai yang Anda masukkan Proxy name. Dasar Path adalah bagian dari URL yang digunakan untuk membuat permintaan ke API Anda. Apigee menggunakan URL untuk mencocokkan dan mengarahkan permintaan masuk ke proxy API yang sesuai.
   • Deskripsi (Opsional): Masukkan deskripsi untuk proxy API baru Anda, seperti seperti "Menguji Apigee dengan proxy sederhana".
   • Target (Existing API): Masukkan https://mocktarget.apigee.net. Ini mendefinisikan URL target yang dipanggil Apigee pada permintaan ke proxy API. Layanan mocktarget memiliki yang dihosting di Apigee dan menampilkan data sederhana. Pengujian 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 lebih lingkungan tempat deployment proxy Anda. Jika Anda memilih untuk tidak menerapkan proxy pada biarkan kolom Lingkungan deployment kosong. Anda selalu dapat men-deploy {i>proxy<i} nanti.
   • Akun Layanan: Opsional. Lampirkan akun layanan ke deployment Anda untuk mengaktifkan untuk 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 di Tampilan ringkasan proxy.

Jika Anda memilih untuk men-deploy proxy, bagian Deployment akan menampilkan Revisi , yaitu 1 saat 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 Proxy API di tampilan utama.
3. Dari menu drop-down Lingkungan, pilih lingkungan yang Anda inginkan untuk membuat proxy API baru.

   UI hybrid menampilkan daftar proxy API untuk lingkungan tersebut. Jika Anda belum membuat {i>proxy<i}, daftarnya kosong.

4. Klik Create New.

   Wizard Create Proxy dimulai.

5. Klik Reverse proxy (paling umum).

   

   Halaman Detail proxy akan ditampilkan.

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

   Detail proxy API Anda akan terlihat seperti berikut:

   

7. Klik Next.
8. Di tampilan Kebijakan umum, di bagian Keamanan: Otorisasi pilih Lulus (tanpa otorisasi).

   

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

    

    Catatan: Jika Anda tidak memilih di bawah Deployment Opsional, tombol di kanan bawah baru diberi label Buat.
    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 menerapkannya ke proxy API lingkungan fleksibel App Engine. Anda dapat mengedit proxy API dan men-deploy proxy API nanti, seperti yang dijelaskan dalam Langkah berikutnya.

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

    

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

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

API Apigee

Buat proxy API di organisasi Apigee Anda dengan mengeluarkan 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: 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
• Meneruskan nama paket konfigurasi proxy API di sistem file lokal Anda

Contoh berikut menunjukkan cara membuat proxy API dengan mengimpor proxy API paket konfigurasi (helloworld-config.zip) di sistem file lokal Anda menggunakan Compute Engine 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"

Jika $TOKEN ditetapkan ke token akses OAuth 2.0 Anda, seperti yang dijelaskan di 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 API Apigee.

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