Mengelola sumber daya

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Lihat dokumentasi Apigee Edge.

Pahami dan kelola resource, seperti yang dijelaskan di bagian berikut.

Tentang resource

Banyak jenis kebijakan mengandalkan resource. Resource adalah file yang mengimplementasikan kode atau konfigurasi yang akan dijalankan oleh kebijakan saat dipasang ke proxy API. Dalam beberapa kasus, seperti JavaScript dan JavaCallout, kebijakan hanya menentukan titik lampiran dalam proxy API tempat beberapa kode harus dieksekusi. Kebijakan JavaScript atau JavaCallout adalah pointer ke resource.

Jenis resource

Tabel berikut merangkum jenis resource:

Jenis aset Deskripsi
GraphQL (graphql) File skema GraphQL yang dirujuk oleh kebijakan GraphQL.
JAR (java) Class Java dalam file JAR yang direferensikan oleh kebijakan JavaCallout.
JavaScript (js) JavaScript yang direferensikan oleh kebijakan JavaScript.
JavaScript (jsc) JavaScript terkompilasi yang direferensikan oleh kebijakan JavaScript.
OpenAPI Specification (oas) Spesifikasi OpenAPI digunakan untuk memvalidasi pesan permintaan dan respons berjenis JSON atau YAML.
Property Set (properties) Kumpulan key-value pair yang dapat direferensikan ke kumpulan properti proxy API.
Python (py) Skrip Python yang direferensikan oleh kebijakan PythonScript. Resource harus diimplementasikan di "pure Python" (hanya dalam bahasa Python).
Security policy (securityPolicy) Kebijakan keamanan kustom yang dirujuk oleh kebijakan JavaCallout.
WSDL (wsdl) File WSDL yang direferensikan oleh kebijakan SOAPMessageValidation.
XSD (xsd) Skema XML yang dirujuk oleh kebijakan SOAPMessageValidation.
XSL Transformations (xsl) Transformasi XSLT yang dirujuk oleh kebijakan XSLTransform.

Tempat resource disimpan

Anda dapat menyimpan resource ke lokasi berikut. Anda tidak dapat menyimpan file resource di organisasi.

  • Revisi proxy API: Resource hanya tersedia untuk revisi proxy API yang menyertakan resource. Misalnya, Anda dapat menyertakan resource JavaScript dengan revisi 1 proxy API, lalu ubah implementasinya untuk menggunakan skrip Python dalam proxy revisi 2. revisi 1 hanya memiliki akses ke resource JavaScript, dan revisi 2 hanya memiliki akses ke resource Python.
  • Lingkungan: Saat disimpan di lingkungan (misalnya test atau prod), resource tersedia untuk semua proxy API yang di-deploy di lingkungan yang sama.

Repositori lingkungan tersedia di URI berikut, seperti yang dijelaskan oleh List resource files API dan selanjutnya di Mengelola resource menggunakan API: /organizations/$ORG/environments/$ENV/resourcefiles

Tabel berikut menunjukkan metode yang dapat Anda gunakan untuk membuat, memperbarui, dan menghapus resource untuk setiap repositori:

Repositori Buat Lihat Pembaruan Hapus
API UI API UI API UI API UI
Revisi proxy API
Lingkungan

Misalnya, semua file JavaScript yang tersedia untuk lingkungan test disimpan di repositori berikut dan tersedia untuk semua proxy API yang berjalan di lingkungan test:

/organizations/$ORG/environments/test/resourcefiles/jsc

Resolusi nama resource

Selesaikan nama resource dari cakupan yang paling spesifik hingga yang paling umum. Nama resource diselesaikan "secara bertahap", dari tingkat revisi proxy API hingga tingkat lingkungan.

Misalnya, Anda telah mengisi resource yang sama di dua repositori yang berbeda, revisi proxy API dan lingkungan prod.

Pertimbangkan proxy API yang dikonfigurasi dengan kebijakan berikut:

<Javascript name='PathSetterPolicy' timeLimit='200'>
    <ResourceURL>jsc://pathSetter.js</ResourceURL>
</Javascript>

Referensi kebijakan tidak dapat di-resolve secara eksplisit menjadi repositori. Resource pertama dengan cakupan paling terperinci yang namanya cocok dengan nama resource dalam kebijakan akan diselesaikan.

Jadi, saat proxy API di-deploy di lingkungan prod, kebijakan akan di-resolve ke resource pathSetter.js cakupan lingkungan.

Saat di-deploy di lingkungan test, Kebijakan akan di-resolve ke resource cakupan revisi proxy API, karena resource cakupan lingkungan berada di lingkungan prod, bukan lingkungan test.

Panduan resource Java

Anda dapat menambahkan resource Java yang dikompilasi sebagai file JAR menggunakan beberapa opsi dalam curl, seperti opsi -T, --data-binary, atau -F (bukan opsi -d). Contoh:

curl "http://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/resourcefiles?name={jar_file}&type=java" \  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/octet-stream" \
  --data-binary @{jar_file}
curl "http://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/resourcefiles?name={jar_file}&type=java" \  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/octet-stream" \
  -T "{jar_file}"
curl "http://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/resourcefiles?name={jar_file}&type=java" \  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/octet-stream" \
  -F "file=@{jar_file}"

Lihat juga:

Mengelola resource menggunakan UI

Kelola resource yang dicakupkan ke revisi proxy API menggunakan UI, seperti yang dijelaskan di bagian berikut.

Melihat resource menggunakan UI

Editor Proxy Baru

Untuk melihat resource menggunakan Proxy Editor baru:

  1. Jika Anda menggunakan Apigee UI di Cloud Console: Pilih Pengembangan proxy > Proxy API.

    Jika Anda menggunakan UI Apigee klasik: Pilih Develop > API Proxies dan di panel Proxies, pilih lingkungan untuk proxy yang resource-nya ingin Anda lihat.

  2. Pilih proxy API yang resource-nya ingin Anda lihat. Tindakan ini akan menampilkan tampilan Overview Proxy Editor.

  3. Klik tab Mengembangkan.
  4. Di panel kiri, scroll ke bawah ke Resources. Resource saat ini akan ditampilkan di bawahnya.

Editor Proxy Klasik

Untuk melihat resource yang dicakupkan ke revisi proxy API menggunakan Proxy Editor klasik:

  1. Login ke UI Apigee.
  2. Pilih Develop > API Proxies di menu navigasi sebelah kiri.
  3. Pilih proxy API dalam daftar tempat Anda ingin membuat resource.
    Editor proxy API terbuka dan tab Ringkasan ditampilkan secara default.
  4. Klik tab Mengembangkan.
  5. Pilih revisi di drop-down Revisi, jika perlu.

    Resource yang dicakupkan ke revisi proxy API tercantum di bagian Resource pada tampilan Navigator.

Membuat resource menggunakan UI

Editor Proxy Baru

Untuk membuat resource menggunakan Proxy Editor baru:

  1. Jika Anda menggunakan Apigee UI di Cloud Console: Pilih Pengembangan proxy > Proxy API.

    Jika Anda menggunakan UI Apigee klasik: Pilih Develop > API Proxies dan di panel Proxies, pilih lingkungan untuk proxy yang resource-nya ingin Anda lihat.

  2. Pilih proxy API yang resource-nya ingin Anda lihat. Tindakan ini akan menampilkan tampilan Overview Proxy Editor.

  3. Klik tab Mengembangkan.
  4. Di panel kiri, scroll ke bawah ke Resources dan klik tombol + di sebelah kanannya.
  5. Pada dialog Add resource, masukkan perintah berikut:
    • Resource type: Pilih jenis file untuk resource.
    • Di bagian Sumber, pilih Buat file baru atau Impor file. Jika Anda memilih Import file, pilih juga file yang akan diimpor di kolom File.
    • Resource name: Masukkan nama untuk fasilitas.
  6. Klik Tambahkan.

Apigee Klasik

Untuk membuat resource yang dicakupkan ke revisi proxy API menggunakan UI Apigee klasik:

  1. Melihat resource yang dicakupkan ke revisi proxy API.
  2. Klik + di bagian Resources pada tampilan Navigator untuk membuka dialog New Resource.
  3. Masukkan:
    Kolom Deskripsi
    Asal Pilih untuk membuat file baru atau mengimpor file.
    Jenis File Pilih jenis resource dari menu drop-down.
    Nama File Nama file. Ekstensi nama file harus valid untuk jenis file yang dipilih.

Mengupdate resource menggunakan UI

Mengupdate resource yang dicakupkan ke revisi proxy API hanya jika revisi belum di-deploy. Setelah revisi proxy API di-deploy, revisi tersebut tidak dapat diubah.

Untuk mengupdate resource yang dicakupkan ke revisi proxy API menggunakan UI:

  1. Melihat resource yang dicakupkan ke revisi proxy API.
  2. Pada tampilan Navigator di bagian Resources, klik resource yang ingin diperbarui.
    Catatan: Untuk file JAR, posisikan kursor di atas resource yang ingin diedit, lalu klik Gambar ikon edit..
  3. Perbarui resource, sesuai kebutuhan.
    Catatan: Setelah mengupload file JAR baru, klik Update.

Menghapus resource menggunakan UI

Menghapus resource yang dicakupkan ke revisi proxy API hanya jika revisi belum di-deploy. Setelah revisi proxy API di-deploy, revisi tersebut tidak dapat diubah.

Untuk menghapus resource yang dicakupkan ke revisi proxy API menggunakan UI:

  1. Melihat resource yang dicakupkan ke revisi proxy API.
  2. Dalam tampilan Navigator di bagian Resources, posisikan kursor di atas resource yang ingin dihapus untuk menampilkan menu tindakan.
  3. Klik Gambar ikon hapus..
  4. Klik Hapus untuk mengonfirmasi tindakan.

Mengelola resource menggunakan API

Mengelola resource menggunakan API, seperti yang dijelaskan di bagian berikut.

Membuat resource menggunakan API

Buat resource yang dicakupkan ke revisi proxy API atau lingkungan, seperti yang dijelaskan di bagian berikut.

Membuat resource yang dicakupkan ke revisi proxy API menggunakan API

Buat resource yang dicakupkan ke revisi proxy API menggunakan API, seperti yang dijelaskan di bagian berikut.

Untuk membuat resource yang dicakupkan ke revisi proxy API menggunakan API:

  1. Buat file resource.
  2. Tambahkan file resource ke paket konfigurasi proxy API.
  3. Upload paket menggunakan salah satu API berikut:

Membuat resource yang dicakupkan ke lingkungan menggunakan API

Buat resource yang dicakupkan ke lingkungan menggunakan API dengan mengeluarkan permintaan POST ke resource berikut: /organizations/$ORG/environments/$ENV/resourcefiles

Teruskan informasi berikut dengan permintaan Anda:

  • Tetapkan parameter kueri name ke nama resource
  • Setel parameter kueri type ke jenis resource yang diperlukan
  • Teruskan konten file resource sebagai application/octet-stream atau multipart/form-data)

Contoh berikut menunjukkan cara membuat resource JavaScript dengan meneruskan kontennya dalam isi permintaan.

curl -X POST https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles?name=pathSetter.js&type=jsc
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type:application/octet-stream" \
  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");'

Tempat $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 variabel lingkungan yang digunakan, lihat Menetapkan variabel lingkungan untuk permintaan Apigee API.

Contoh berikut menunjukkan cara mengupload resource sebagai file dari mesin lokal Anda. Penting untuk menggunakan -F untuk upload biner dalam curl agar file JavaScript cakupan lingkungan atau organisasi dapat diakses oleh kebijakan JavaScript.

curl -X POST https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles?name=pathSetter.js&type=jsc
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type:multipart/form-data" \
  -F file=@pathSetter.js

Berikut adalah contoh responsnya:

{
  "name" : "pathSetter.js",
  "type" : "jsc"
}

Melihat resource menggunakan API

Bagian berikut menjelaskan cara melihat resource menggunakan API.

Melihat semua resource yang menggunakan API

Lihat semua resource yang dicakupkan ke lingkungan yang menggunakan API, seperti yang dijelaskan di bagian berikut.

Dengan menggunakan API, Anda dapat melihat resource yang dicakupkan ke lingkungan saja.

Untuk melihat semua resource di lingkungan menggunakan API, berikan permintaan GET ke resource berikut: https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/resourcefiles

Contoh berikut mencantumkan semua resource di lingkungan test:

curl -X GET https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles
  -H "Authorization: Bearer $TOKEN"

Tempat $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 variabel lingkungan yang digunakan, lihat Menetapkan variabel lingkungan untuk permintaan Apigee API.

Untuk mengetahui informasi selengkapnya, lihat Mencantumkan API file resource lingkungan.

Berikut adalah contoh responsnya.

{
  "resourceFile": [
{
  "name" : "pathSetter.js",
  "type" : "jsc"
}
  ]
}

Melihat konten resource menggunakan API

Untuk melihat konten resource di lingkungan menggunakan API, berikan permintaan GET ke resource berikut: /organizations/$ORG/environments/$ENV/resourcefiles/$TYPE/$NAME

Contoh berikut mencantumkan konten file pathSetter.js JavaScript (jsc) di lingkungan test:

curl -X GET https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js
  -H "Authorization: Bearer $TOKEN"

Tempat $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 variabel lingkungan yang digunakan, lihat Menetapkan variabel lingkungan untuk permintaan Apigee API.

Berikut adalah contoh responsnya:

request.headers["RequestPath"] = context.getVariable("proxy.basepath");

Mengupdate resource menggunakan API

Update resource yang dicakupkan ke revisi proxy API atau lingkungan, seperti yang dijelaskan di bagian berikut.

Mengupdate resource yang dicakupkan ke revisi proxy API menggunakan API

Untuk mengupdate resource yang dicakupkan ke revisi proxy API menggunakan API:

  1. Download paket konfigurasi proxy API menggunakan Get API proxy Revision API dengan opsi berikut:
    • Tetapkan parameter kueri format ke bundle
    • Setel header Accept ke application/zip
  2. Perbarui file resource dalam paket konfigurasi proxy API.
  3. Upload paket konfigurasi proxy API menggunakan API Update proxy proxy Tambahkan API.

Mengupdate resource yang dicakupkan ke lingkungan menggunakan API

Update resource yang dicakupkan ke lingkungan menggunakan API dengan mengajukan permintaan PUT ke resource berikut: /organizations/$ORG/environments/$ENV/resourcefiles/$TYPE/$NAME

Teruskan konten file resource sebagai application/octet-stream atau multipart/form-data.

Contoh berikut menunjukkan cara mengupdate resource JavaScript dengan meneruskan kontennya dalam isi permintaan.

curl -X PUT https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type:application/octet-stream" \
  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");'

Tempat $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 variabel lingkungan yang digunakan, lihat Menetapkan variabel lingkungan untuk permintaan Apigee API.

Contoh berikut menunjukkan cara mengupdate file resource menggunakan file dari mesin lokal Anda. Penting untuk menggunakan -F untuk upload biner dalam curl agar file JavaScript cakupan lingkungan atau organisasi dapat diakses oleh kebijakan JavaScript.

curl -X PUT https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type:multipart/form-data" \
  -F file=@pathSetter.js

Berikut adalah contoh responsnya:

{
  "name" : "pathSetter.js",
  "type" : "jsc"
}

Menghapus resource menggunakan API

Hapus resource yang dicakupkan ke revisi proxy API atau lingkungan, seperti yang dijelaskan di bagian berikut.

Menghapus resource yang dicakupkan ke revisi proxy API menggunakan API

Dengan hybrid, untuk menghapus resource yang dicakupkan ke proxy API menggunakan API:

  1. Download paket konfigurasi proxy API menggunakan Get API proxy Revision API dengan opsi berikut:
    • Tetapkan parameter kueri format ke bundle
    • Setel header Accept ke application/zip
  2. Hapus file resource dari paket konfigurasi proxy API.
  3. Upload paket konfigurasi proxy API menggunakan API Update proxy proxy Tambahkan API.

Menghapus resource yang dicakupkan ke lingkungan menggunakan API

Menghapus resource yang dicakupkan ke lingkungan menggunakan API, seperti yang dijelaskan di bagian berikut.

Untuk menghapus resource yang dicakupkan ke lingkungan menggunakan API, berikan permintaan DELETE ke resource berikut: https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/resourcefiles/$TYPE/$NAME

Contoh berikut menghapus file resource JavaScript pathSetter.js dari lingkungan test:

curl -X DELETE https://apigee.googleapis.com/v1/organizations/my-organization/environments/test/resourcefiles/jsc/pathSetter.js \
  -H "Authorization: Bearer $TOKEN"
  

Tempat $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 variabel lingkungan yang digunakan, lihat Menetapkan variabel lingkungan untuk permintaan Apigee API.

Untuk informasi selengkapnya, lihat Menghapus API file resource.

Berikut adalah contoh responsnya.

{
  "name" : "pathSetter.js",
  "type" : "jsc"
}

Mengakses referensi

Cara Anda mengakses resource bergantung pada jenis resource. Untuk mendapatkan informasi selengkapnya, lihat Ringkasan referensi kebijakan.

Contoh di bagian ini menunjukkan cara membuat dan mengelola resource JavaScript bernama pathSetter.js agar dapat direferensikan oleh kebijakan jenis JavaScript.

Untuk melampirkan JavaScript ke PostFlow Permintaan, buat kebijakan bernama PathSetterPolicy.xml yang mereferensikan file pathSetter.js:

<Javascript name='PathSetterPolicy' timeLimit='200'>
    <ResourceURL>jsc://pathSetter.js</ResourceURL>
</Javascript>

Selanjutnya, lihat kebijakan tersebut di konfigurasi Endpoint:

<PostFlow>
  <Request>
    <Step><Name>PathSetterPolicy</Name></Step>
  </Request>
<PostFlow>

Untuk informasi selengkapnya, lihat kebijakan JavaScript.