Dukungan untuk header respons HTTP

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X.
info

Topik ini menjelaskan cara Edge menangani header cache HTTP/1.1 saat Anda menggunakan kebijakan ResponseCache. Apigee Edge saat ini mendukung subset header dan perintah caching HTTP/1.1 (fitur yang tidak didukung tercantum dalam topik ini) yang diterima dari server target backend (asal).

Selain itu, dengan header tertentu Edge mengambil tindakan berdasarkan arahannya. Dalam beberapa kasus, header cache HTTP/1.1 ini menggantikan perilaku apa pun yang ditentukan dalam kebijakan ResponseCache. Misalnya, jika header Cache-Control ditampilkan dari server backend, Anda dapat mengatur perintah s-maxage header agar berpotensi menggantikan setelan habis masa berlaku lainnya dalam kebijakan.

Header Dukungan
Cache-Control Didukung pada respons yang ditampilkan dari server asal backend, tetapi tidak pada permintaan klien. Edge mendukung subset perintah.
Berakhir Didukung. Dapat diganti.
Tag Entitas (ETag) Perilaku spesifik untuk If-Match dan If-None-Match.
Jika-Dimodifikasi-Sejak Pada permintaan GET, header diteruskan ke server asal meskipun ada entri cache yang valid.
Menerima Encoding Edge mengirimkan respons yang dikompresi atau tidak dikompresi, bergantung pada header yang masuk.

Cache-Control

Apigee Edge hanya mendukung header Cache-Control pada respons yang ditampilkan dari server asal backend (spesifikasi HTTP/1.1 memungkinkan header Cache-Control dalam permintaan klien dan respons server origin). Server asal dapat menyertakan endpoint target yang ditentukan dalam proxy Apigee Edge API dan yang dibuat menggunakan panggilan API TargetServer.

Batasan dukungan Cache-Control

Apigee Edge mendukung subset kemampuan header respons Cache-Control yang ditentukan dalam spesifikasi HTTP/1.1. Harap perhatikan hal berikut:

  • Apigee Edge tidak mendukung header Cache-Control yang diterima dengan permintaan klien masuk.
  • Apigee Edge hanya mendukung gagasan cache publik. (Menurut spesifikasi HTTP, Cache-Control dapat bersifat publik (bersama) atau pribadi (satu pengguna).)
  • Apigee Edge hanya mendukung subset perintah respons Cache-Control dalam spesifikasi HTTP/1.1. Lihat Dukungan untuk perintah header respons Cache-Control untuk mengetahui detailnya.

Dukungan untuk perintah header respons Cache-Control

Apigee mendukung perintah subset dari spesifikasi HTTP/1.1 pada respons dari server asal. Tabel berikut menjelaskan dukungan Apigee Edge untuk perintah header respons Cache-Control HTTP.

Untuk informasi lebih terperinci tentang perintah yang tercantum di sini, lihat Cache-Control dalam spesifikasi HTTP/1.1.

Perintah Cache-Control Cara Apigee Edge memproses perintah
cache-extension Tidak didukung.
max-age

Jika kebijakan ResponseCache Anda menetapkan elemen <UseResponseCacheHeaders> ke true, respons dapat di-cache selama jumlah detik yang ditentukan oleh perintah ini.

Perintah ini diganti oleh perintah s-maxage dan menggantikan header Expires. Atribut ini juga dapat diganti oleh elemen <ExpirySettings> kebijakan. Untuk mengetahui informasi selengkapnya, lihat "Menetapkan habis masa berlaku entri cache" dan <UseResponseCacheHeaders> di kebijakan Cache Respons.

must-revalidate Tidak didukung. Semua entri cache dihapus oleh Apigee Edge segera setelah masa berlakunya habis.
no-cache

Edge meng-cache respons origin, tetapi harus divalidasi ulang dengan server origin sebelum digunakan untuk memenuhi permintaan klien berikutnya. Aturan ini memungkinkan origin menampilkan respons 304 Not Modified untuk menunjukkan bahwa respons harus ditampilkan dari cache, sehingga menghemat pemrosesan yang diperlukan untuk menampilkan seluruh respons. Jika server asal menampilkan respons lengkap, server asal akan menggantikan entri cache yang ada. Setiap nama kolom yang ditentukan dengan perintah ini akan diabaikan.

no-store Tidak didukung.
no-transform Tidak didukung.
private Tidak didukung. Jika perintah ini diterima, respons origin tidak akan di-cache. Setiap nama kolom akan diabaikan.
proxy-revalidate Tidak didukung. Semua entri cache dihapus oleh Apigee Edge segera setelah masa berlakunya habis.
public Edge meng-cache respons origin, meskipun perintah lain menunjukkan sebaliknya. Sesuai spesifikasi HTTP/1.1, satu-satunya pengecualian untuk aturan ini adalah jika responsnya menyertakan header Authorization.
s-maxage

Jika kebijakan ResponseCache Anda menetapkan elemen <UseResponseCacheHeaders> ke true, respons dapat di-cache selama jumlah detik yang ditentukan oleh perintah ini.

Perintah ini menggantikan perintah max-age dan header Expires. Atribut ini dapat diganti oleh elemen <ExpirySettings> kebijakan. Untuk mengetahui informasi selengkapnya, lihat "Menetapkan habis masa berlaku entri cache" dan <UseResponseCacheHeaders> di kebijakan Cache Respons.

Berakhir

Jika flag UseResponseCacheHeaders dalam kebijakan ResponseCache ditetapkan ke true, Edge dapat menggunakan header Expires untuk menentukan time to live (TTL) entri yang di-cache. Header ini menentukan tanggal/waktu saat entri cache respons dianggap tidak berlaku. Header ini memungkinkan server memberikan sinyal kapan saatnya menampilkan nilai yang di-cache berdasarkan stempel waktu.

Format tanggal yang dapat diterima untuk header Expires dijelaskan dalam spesifikasi HTTP/1.1. Contoh:

Berakhir: Kamis, 01 Des 1994 16:00:00 GMT

Untuk informasi detail tentang format tanggal/waktu HTTP, lihat Format Tanggal/Waktu dalam spesifikasi HTTP/1.1.

Untuk informasi selengkapnya tentang header Expires, lihat Definisi Kolom Header dalam spesifikasi HTTP/1.1.

ETag

Tag entitas (ETag) adalah pengenal yang terkait dengan sumber daya yang diminta. Dengan ETag, server dapat menentukan apakah resource yang diminta dan resource ter-cache terkait cocok. Misalnya, server dapat meng-cache ulang respons jika tidak cocok dengan cache saat ini. ETag dapat menampilkan resource yang disimpan dalam cache jika ETag cocok.

Saat endpoint target mengirimkan respons kembali ke Edge dengan ETag, Edge akan meng-cache ETag bersama dengan responsnya.

Anda dapat membaca Tag Entitas lebih lanjut di Parameter Protokol pada spesifikasi HTTP/1.1.

Jika Cocok

Dengan header permintaan If-Match, entity yang disimpan dalam cache adalah entitas aktif jika ETag di header cocok dengan ETag yang di-cache. Setiap permintaan selain GET yang menentukan header If-Match akan diteruskan ke server origin untuk memastikan bahwa fasilitas caching origin memiliki kesempatan untuk memproses permintaan.

Anda dapat membaca selengkapnya tentang If-Match di Definisi Kolom Header dalam spesifikasi HTTP/1.1.

Jika Edge menerima permintaan GET masuk dari klien yang menyertakan header If-Match:

Jika Selanjutnya,
Header If-Match menentukan satu atau beberapa ETag
  1. Apigee Edge mengambil entri cache yang belum habis masa berlakunya untuk resource yang ditentukan dan membandingkan ETag yang kuat pada entri yang disimpan dalam cache tersebut dengan yang ditetapkan dalam header If-Match.
  2. Jika ditemukan kecocokan, entri cache akan ditampilkan.
  3. Jika tidak, permintaan akan diteruskan ke server asal.
Header If-Match menentukan "*" Permintaan diteruskan ke server asal untuk memastikan bahwa fasilitas caching asal memiliki kesempatan untuk memproses permintaan tersebut
Ditemukan entri cache dengan URI permintaan yang sama, namun hanya berisi ETag yang lemah Entri harus divalidasi ulang oleh server asal sebelum ditampilkan ke klien
ETag berasal dari server asal. ETag ditampilkan tanpa perubahan ke klien

Jika-Tidak Ada-Cocok

Dengan header If-None-Match, entity yang disimpan dalam cache adalah entitas aktif jika ETag di header tidak sesuai dengan ETag yang di-cache. Permintaan selain GET yang berisi header ini diteruskan ke server asal.

Jika Edge menerima permintaan GET masuk dengan header ini:

Jika Selanjutnya,
Header If-None-Match menentukan satu atau beberapa ETag
  1. Apigee Edge mengambil entri cache yang belum habis masa berlakunya untuk URI yang ditentukan dan membandingkan ETag yang kuat pada entri yang disimpan dalam cache tersebut dengan yang ditetapkan dalam header If-None-Match.
  2. Jika ditemukan kecocokan, Edge akan menampilkan status 304 Not Modified. Jika tidak ada kecocokan yang ditemukan, Edge akan meneruskan permintaan ke server asal.

Header If-None-Match menentukan "*" dan entri cache yang belum habis masa berlakunya untuk URI yang diminta sudah ada

Edge menampilkan status 304 Not Modified
Entri cache dengan URI permintaan yang sama ditemukan namun hanya berisi ETag yang lemah Entri harus divalidasi ulang oleh server asal sebelum Edge mengembalikannya ke klien
Edge menerima ETag dari server asal ETag ditampilkan tanpa perubahan ke klien

Jika-Diubah-Sejak

Jika Apigee Edge menerima header If-Modified-Since dalam permintaan GET, header tersebut akan diteruskan ke server asal meskipun ada entri cache yang valid.

Hal ini memastikan bahwa setiap update pada resource yang tidak melewati Apigee Edge akan diperhitungkan. Jika server origin menampilkan entity baru, Edge akan mengganti entri cache yang ada dengan nilai baru. Jika server menampilkan status 304 Not Modified, Edge akan menampilkan nilai respons jika header Last-Modified respons yang di-cache menunjukkan bahwa header belum berubah.

Terima Encoding

Saat permintaan masuk menyertakan header Accept-Encoding dengan nilai gzip, deflate, atau compress, server asal akan merespons dengan data terkompresi. Jika permintaan berikutnya datang tanpa header Accept-Encoding, permintaan tersebut mengharapkan respons yang tidak dikompresi. Mekanisme cache respons Apigee mampu mengirim respons yang dikompresi dan tidak dikompresi, tergantung pada header yang masuk tanpa kembali ke server asal.

Anda dapat menambahkan nilai header Accept ke kunci cache untuk membuat kunci tersebut lebih bermakna bagi setiap item yang di-cache. Untuk mengetahui detail selengkapnya, lihat "Mengonfigurasi kunci cache" di kebijakan Cache Respons.