RewritePlugin

要求を書き換える。

プラグイン インスタンスの定義

{
  "name": "RewritePlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll",
  "configSection": "rewritePlugin"
}

構成の例

{
  "rewritePlugin": {
    "rewritesFile": "rewrites.json"
  }
}

構成プロパティ

プロパティ	説明	Default
rewritesFile	書き換え定義を含むファイルへのパス	rewrites.json

コマンドライン オプション

なし

ファイルの書き換えの例

書き換えルールの例を次に示します。

HTTP から HTTPS へのすべての要求を書き換える

HTTP から HTTPS へのすべての要求を書き換える。 このコンテキストでは、 all は、開発プロキシまたは RewritePlugin で構成されたすべての要求を意味します。

{
  "rewrites": [
    {
      "in": {
        "url": "^http://(.*)"
      },
      "out": {
        "url": "https://$1"
      }
    }
  ]
}

モック ファイルのプロパティ

プロパティ	内容	必須
rewrites	rewritePlugin がインターセプトする要求に適用される書き換え規則の一覧を定義するrewrite オブジェクトの配列	はい

オブジェクトの書き換え

各書き換えルールには、次のプロパティがあります。

プロパティ	内容	必須
in	パターンの書き換え 受信要求に一致するようにします。	はい
out	書き換えパターン 要求を書き換える	はい

解説

RewritePlugin がインターセプトする要求が、 in パターンで定義されているすべてのプロパティと一致しない場合、プラグインは書き換えルールを要求に適用しません。

書き換えパターン

各書き換えパターンには、次のプロパティがあります。

プロパティ	内容	必須	規定値	値の例
url	プラグインが URL に適用する正規表現。	はい		^http://(.*)

解説

in パターンの正規表現でキャプチャ グループを使用する場合は、out パターンでそれらを参照できます。 たとえば、 http://example.com/foo を https://example.com/fooに書き換える場合は、次の書き換え規則を使用できます。

{
  "in": {
    "url": "^http://(.*)"
  },
  "out": {
    "url": "https://$1"
  }
}