上書き可能パラメータを設定すると、パスパラメータで標準の変換設定を定義したまま、指定した変換パラメータだけをURLから変更・追加できます。
基本ルール
ImageFluxはリクエストURLを先頭から順に解析し、以下をImageFlux用の情報として判定します。
-
/c
-
/c!
-
パスパラメータ(Base Prefix)
-
変換パラメータ(例:
w=400)
URLパスの先頭がいずれにも一致しない場合、その時点からオリジンへのリクエストパスとして扱われます。
例
/c!/w=400/example.jpg
/c!とw=400はImageFlux用の情報として解釈され、example.jpgはオリジンへのリクエストパスとして扱われます。
上書き可能パラメータの用途
上書き可能パラメータは、パスパラメータで標準的な変換設定を定義しつつ、一部の変換パラメータのみをURLから指定できるようにしたい場合に利用します。
例えば、次のようなケースで利用できます。
-
/small/ は幅300pxのサムネイルとして提供したい
-
利用者には幅 (
w) のみ変更を許可したい -
フォーマット (
f) やその他の変換設定は固定したい
パスパラメータについては、パスパラメータについて詳しく知りたいをご参照ください。
上書き可能パラメータの設定方法
オリジン追加画面にて、URLで指定可能な変換パラメータをカンマ区切りで指定します。
この機能を有効にすると、指定されていない変換パラメータがURLに含まれている場合、リクエストはエラーになります。
また、パスパラメータ設定で[URLによるパラメータの上書き・変更を許可しない]を有効にしている場合は、パスパラメータの設定が優先されます。
設定例
オリジン設定の上書き可能パラメータ
w,q
パスパラメータ
|
Base Prefix |
small |
|---|---|
|
Parameter |
w=300,a=0,u=1,f=webp |
この場合、上書き可能パラメータとして許可されているwとqを、URLで指定できます。
https://p1-XXXXXXXX.imageflux.jp/w=700,q=80/small/example.jpg
最終的に以下の変換パラメータが適用されます。
w=700,a=0,u=1,f=webp,q=80
-
w:URLの700で上書きされます -
q:URLから80が追加されます -
a、u、f:パスパラメータで設定した値が使用されます
エラーとなる例
上書き可能パラメータがw,qの場合、以下のURLはエラーになります。
https://p1-XXXXXXXX.imageflux.jp/w=700,q=80,f=png/small/example.jpg
fは上書き可能パラメータとして許可されていないためです。
パスパラメータで上書きを禁止する場合
パスパラメータ設定で[URLによるパラメータの上書き・変更を許可しない]を有効にすると、URLから指定した変換パラメータは適用されません。
例えば、以下の状態でURLからw=700,q=80を指定しても、URLの値は適用されません。
|
Base Prefix |
small |
|---|---|
|
Parameter |
w=300,a=0,u=1,f=webp |
|
[URLによるパラメータの上書き・変更を許可しない] |
有効 |
この場合、URLで指定した w や q
は適用されず、パスパラメータで設定したw=300,a=0,u=1,f=webpのみが使用されます。