URLディスカバリープラグイン

開発プロキシがインターセプトした URL の一覧を作成します。 このプラグインを使用して、アプリが呼び出している URL と、アプリの動作をシミュレートするように開発プロキシを構成する方法を学習します。

先端

概要をファイルに保存するには、構成でレポーター プラグインを使用します。

構成の例

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v4.0.0/rc.schema.json",
  "plugins": [
    {
      "name": "UrlDiscoveryPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll"
    }
  ]
}

構成プロパティ

何一つ

出力

記録を停止すると、UrlDiscoveryPlugin によってレポートが作成されます。 レポートには、Dev Proxy がインターセプトした要求の一意の URL がアルファベット順に並べ替えられています。 各 URL は、クエリ文字列を含む完全な要求 URL です。

レポートを JSON として保存するには、構成で UrlDiscoveryPlugin の後に JsonReporter を追加します。 JsonReporter は、現在の作業ディレクトリ内の UrlDiscoveryPlugin_JsonReporter.jsonc という名前のファイルにレポートを書き込みます。 ファイルが既に存在する場合、Dev Proxy は、 UrlDiscoveryPlugin_JsonReporter_20261105104151.jsoncなどのタイムスタンプをファイル名に追加します。

このファイルは、開発プロキシ構成の urlsToWatch プロパティの開始点として使用できる、コメント付き JSON (JSONC) ファイルです。 このファイルには、ワイルドカードの使用方法と URL の除外方法を説明するコメントと、インターセプトされた URL を含む urlsToWatch 配列が含まれています。

{
  // Wildcards
  // 
  // You can use wildcards to catch multiple URLs with the same pattern.
  // For example, you can use the following URL pattern to catch all API requests to
  // JSON Placeholder API:
  // 
  // https://jsonplaceholder.typicode.com/*
  // 
  // Excluding URLs
  // 
  // You can exclude URLs with ! to prevent them from being intercepted.
  // For example, you can exclude the URL https://jsonplaceholder.typicode.com/authors
  // by using the following URL pattern:
  // 
  // !https://jsonplaceholder.typicode.com/authors
  // https://jsonplaceholder.typicode.com/*
  "urlsToWatch": [
    "https://jsonplaceholder.typicode.com/posts",
    "https://jsonplaceholder.typicode.com/users",
    "https://jsonplaceholder.typicode.com/users/1"
  ]
}

プロパティ	Description
urlsToWatch	文字列の配列。 記録中に Dev Proxy が傍受した要求の一意の URL。アルファベット順に並べ替えられます。 URL にワイルドカードが含まれていない

Important

ファイルにはコメントが含まれているため、JavaScript や jq のJSON.parseなど、標準の JSON パーサーでは解析に失敗します。 スクリプトでファイルを読み取る場合は、 JSON5 や jsonc-parser npm パッケージなどのコメントをサポートするパーサーを使用するか、ファイルを解析する前にコメント行を削除します。

参照

• スクリプトと CI からのレコード
• CI/CD シナリオで開発プロキシを使用する
• プロキシ API

次のステップ

ウォッチする URL を検出する