Mengedit proxy API (membuat revisi proxy)

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat dokumentasi Apigee Edge.

Gunakan UI atau API Apigee untuk mengedit proxy API. Saat mengedit proxy API, Anda dapat memutuskan manakah dari opsi berikut yang akan dilakukan dengan perubahan yang dihasilkan:

  1. Simpan perubahan di server, tetapi jangan buat revisi baru. Anda melakukannya jika tidak ingin men-deploy perubahan yang disimpan, tetapi hanya ingin memastikan bahwa perubahan tersebut tidak hilang jika Anda mengakhiri sesi.

    ATAU

  2. Buat revisi proxy API baru dan deploy ke cluster. Anda tidak dapat men-deploy perubahan ke proxy API tanpa membuat revisi baru.

Editor Proxy Baru

Untuk mengedit proxy API dan menyimpan perubahan menggunakan Editor Proxy baru:

  1. Jika Anda menggunakan UI Apigee di Cloud Console: Pilih Proxy development > API Proxies.

    Jika Anda menggunakan UI Apigee klasik: Pilih Develop > API Proxies dan di panel Proxies, pilih lingkungan untuk proxy.

  2. Pilih proxy yang ingin Anda edit dari daftar proxy. UI menampilkan tab Ringkasan untuk proxy tersebut di Editor Proxy.

    Tab Ringkasan di Editor Proxy
  3. Klik tab Mengembangkan.
  4. Gunakan Editor Proxy untuk membuat perubahan pada proxy. Setelah selesai melakukan perubahan, Anda dapat melakukan salah satu hal berikut:
    • Untuk menyimpan perubahan, tetapi tidak membuat revisi baru, klik tombol Simpan. (Anda harus melakukannya secara berkala untuk memastikan perubahan tidak hilang jika Anda mengakhiri sesi).
    • Untuk menyimpan perubahan sebagai revisi baru (saat Anda bersiap untuk men-deploy dan menguji), klik menu drop-down di samping tombol Simpan, lalu pilih Simpan sebagai revisi baru:

      Simpan perubahan sebagai revisi baru di menu Simpan.

      UI Apigee akan menyimpan perubahan Anda dan membuat revisi baru proxy untuk Anda. Tindakan ini tidak men-deploy paket baru ke runtime; Anda harus melakukannya secara eksplisit, seperti yang dijelaskan dalam Men-deploy proxy API.

Editor Proxy Klasik

Untuk mengedit proxy API dan menyimpan perubahan menggunakan Editor Proxy klasik:

  1. Login ke UI Apigee.
  2. Klik API Proxies di tampilan utama.

    Atau, Anda dapat memilih Develop > API Proxies di menu navigasi sebelah kiri.

  3. Pilih lingkungan yang berisi proxy yang ingin Anda edit.

    UI Apigee menampilkan daftar proxy API untuk lingkungan yang dipilih:

    Daftar proxy untuk lingkungan yang dipilih.

  4. Klik proxy yang ingin diedit. UI akan menampilkan tab Ringkasan untuk proxy tersebut di Editor Proxy:

    Tab Ringkasan di Editor Proxy.

  5. Klik tab Develop di kanan atas tampilan.
  6. Gunakan editor proxy untuk membuat perubahan pada proxy. Setelah selesai melakukan perubahan, Anda dapat melakukan salah satu hal berikut:
    • Simpan perubahan, tetapi jangan buat revisi baru (paling umum; Anda harus melakukannya secara berkala untuk memastikan perubahan tidak hilang jika Anda mengakhiri sesi).
    • Simpan perubahan sebagai revisi baru (saat Anda bersiap untuk men-deploy dan menguji).
  7. Untuk menyimpan, tetapi tidak membuat revisi baru, klik Simpan di kanan atas UI:

    Tombol Simpan.

    UI Apigee menyimpan perubahan Anda sehingga Anda dapat keluar dari halaman dan melanjutkan pekerjaan nanti.

  8. Untuk menyimpan perubahan sebagai revisi baru, klik panah drop-down di samping Simpan, lalu pilih Simpan sebagai revisi baru:

    Klik Simpan sebagai revisi baru

    UI Apigee akan menyimpan perubahan Anda dan membuat paket proxy baru untuk Anda. Tindakan ini tidak men-deploy paket baru ke runtime; Anda harus melakukannya secara eksplisit, seperti yang dijelaskan dalam Men-deploy proxy API.

    UI akan menampilkan pesan Revisi baru disimpan:

    Pesan revisi baru yang disimpan ditampilkan di UI.

    Setelah membuat revisi baru, Anda biasanya men-deploynya ke cluster, seperti yang dijelaskan dalam Men-deploy proxy API.

Apigee API

Edit proxy API untuk membuat revisi 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 mengedit proxy API dengan mengimpor paket konfigurasi proxy API (helloworld-config.zip) di sistem file lokal Anda menggunakan API.

export TOKEN=$(gcloud auth print-access-token)
export ORG=ORGANIZATION_NAME
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 mengedit proxy API, lihat metode apis.create di Apigee API. Untuk melihat semua metode yang tersedia untuk proxy API, lihat API proxy API.