Mengelola resource

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 bergantung pada resource. Resource adalah file yang menerapkan kode atau konfigurasi yang akan dieksekusi oleh kebijakan saat dilampirkan ke proxy API. Dalam beberapa kasus, seperti dengan JavaScript dan JavaCallout, kebijakan hanya menentukan titik lampiran di proxy API tempat beberapa kode harus dieksekusi. Kebijakan JavaScript atau JavaCallout adalah pointer ke resource.

Jenis resource

Tabel berikut merangkum jenis resource:

Tempat penyimpanan resource

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 tersebut. Misalnya, Anda dapat menyertakan resource JavaScript dengan revisi 1 proxy API, lalu mengubah penerapannya untuk menggunakan skrip Python dalam revisi 2 proxy. 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 proxy API apa pun 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:

Misalnya, semua file JavaScript yang tersedia untuk lingkungan test disimpan di repositori berikut dan tersedia untuk proxy API apa pun 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 di-resolve "naik ke atas", dari tingkat revisi proxy API, ke tingkat lingkungan.

Misalkan 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 secara eksplisit di-resolve ke repositori. Resource pertama pada cakupan paling terperinci yang namanya cocok dengan nama resource dalam kebijakan akan diselesaikan.

Jadi, saat proxy API di-deploy di lingkungan prod, kebijakan akan diselesaikan ke resource pathSetter.js yang tercakup dalam lingkungan.

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

Panduan resource Java

Anda dapat menambahkan resource Java yang dikompilasi sebagai file JAR menggunakan beberapa opsi di 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:

• Praktik terbaik Java: Praktik terbaik untuk desain dan pengembangan proxy API
• Contoh panduan Java: Kebijakan Transformasi XSL

Mengelola resource menggunakan UI

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

Melihat resource menggunakan UI

Membuat resource menggunakan UI

Memperbarui resource menggunakan UI

Memperbarui cakupan resource ke revisi proxy API hanya jika revisi belum di-deploy. Setelah di-deploy, revisi proxy API tidak dapat diubah.

Untuk memperbarui resource yang dicakup ke revisi proxy API menggunakan UI:

1. Lihat resource yang dicakup ke revisi proxy API.
2. Di tampilan Navigator pada bagian Resources, klik resource yang ingin Anda perbarui.
   Catatan: Untuk file JAR, posisikan kursor Anda di atas resource yang ingin Anda edit, lalu klik .
3. Perbarui resource, sesuai kebutuhan.
   Catatan: Setelah mengupload file JAR baru, klik Perbarui.

Menghapus resource menggunakan UI

Hapus resource yang dicakup ke revisi proxy API hanya jika revisi belum di-deploy. Setelah di-deploy, revisi proxy API tidak dapat diubah.

Untuk menghapus cakupan resource ke revisi proxy API menggunakan UI:

1. Lihat resource yang dicakup ke revisi proxy API.
2. Di tampilan Navigator di bagian Resources, posisikan kursor Anda di atas resource yang ingin Anda hapus untuk menampilkan menu tindakan.
3. Klik .
4. Klik Hapus untuk mengonfirmasi tindakan.

Mengelola resource menggunakan API

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

Membuat resource menggunakan API

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

Membuat resource yang dicakup ke revisi proxy API menggunakan API

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

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

Membuat resource yang dicakup ke lingkungan menggunakan API

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

Teruskan informasi berikut dengan permintaan Anda:

• Tetapkan parameter kueri name ke nama resource
• Tetapkan 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 isinya di 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");'

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

Contoh berikut menunjukkan cara mengupload resource sebagai file dari komputer lokal Anda. Anda harus menggunakan -F untuk upload biner di curl agar file JavaScript yang tercakup dalam 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 respons:

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

Melihat resource menggunakan API

Bagian berikut menjelaskan cara melihat resource menggunakan API.

Melihat semua resource menggunakan API

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

Dengan menggunakan API, Anda hanya dapat melihat resource yang dicakup ke lingkungan.

Untuk melihat semua resource di lingkungan menggunakan API, kirim 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"

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

Untuk mengetahui informasi selengkapnya, lihat List environment resource files API.

Berikut adalah contoh responsnya.

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

Melihat konten resource menggunakan API

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

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

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

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

Berikut adalah contoh respons:

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

Memperbarui resource menggunakan API

Perbarui resource yang dicakup ke revisi proxy API atau lingkungan, seperti yang dijelaskan di bagian berikut.

Memperbarui resource yang dicakup ke revisi proxy API menggunakan API

Untuk memperbarui resource yang dicakup 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
   • Tetapkan header Accept ke application/zip
2. Perbarui file resource di paket konfigurasi proxy API.
3. Upload paket konfigurasi proxy API menggunakan API Perbarui revisi proxy API.

Memperbarui resource yang dicakup ke lingkungan menggunakan API

Perbarui resource yang dicakup ke lingkungan menggunakan API dengan mengirimkan 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 isinya di 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");'

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

Contoh berikut menunjukkan cara memperbarui file resource menggunakan file dari mesin lokal Anda. Anda harus menggunakan -F untuk upload biner di curl agar file JavaScript yang tercakup dalam 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 respons:

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

Menghapus resource menggunakan API

Hapus resource yang tercakup dalam revisi proxy API atau lingkungan, seperti yang dijelaskan di bagian berikut.

Menghapus resource yang dicakup ke revisi proxy API menggunakan API

Dengan hybrid, untuk menghapus resource yang dicakup 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
   • Tetapkan header Accept ke application/zip
2. Hapus file resource dari paket konfigurasi proxy API.
3. Upload paket konfigurasi proxy API menggunakan API Perbarui revisi proxy API.

Menghapus resource yang dicakup ke lingkungan menggunakan API

Hapus resource yang dicakup ke lingkungan menggunakan API, seperti yang dijelaskan di bagian berikut.

Untuk menghapus resource yang dicakup ke lingkungan menggunakan API, kirim 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"
  

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

Untuk mengetahui informasi selengkapnya, lihat API hapus file resource.

Berikut adalah contoh responsnya.

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

Mengakses resource

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

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

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

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

Kemudian, rujuk kebijakan dalam konfigurasi Endpoint:

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

Untuk mengetahui informasi selengkapnya, lihat Kebijakan JavaScript.