独自のアプリケーションのランダム エラーをシミュレートする

このチュートリアルでは、開発プロキシを使用して、独自のアプリケーションのランダム なエラーをシミュレートする方法について説明します。

前提条件

このチュートリアルのこの部分では、マシンに開発プロキシをインストールして構成していることを前提としています。 そうでない場合は、 今すぐ行います。

このチュートリアルに従うには、API を呼び出すアプリケーションが必要です。 また、アプリケーションが呼び出す API の URL も把握しておく必要があります。

開発プロキシは、任意の種類のアプリケーションとテクノロジ スタックで使用できます。 ここでは、いくつかの一般的なテクノロジを使用して開発プロキシを設定する方法について説明します。

JavaScript

次の場合に開発プロキシを使用します。

• Node.js アプリケーション
• Docker でアプリケーションをNode.js する
• JavaScript Azure Functions
• SharePoint Framework (SPFx) ソリューション

.NET

次の場合に開発プロキシを使用します。

• .NET アプリケーション
• Docker の .NET アプリケーション
• .NET Aspire アプリケーション

.NET 4.8 アプリで開発プロキシを使用している場合は、 を使用してnetsh開発プロキシをシステムに登録する必要があります。

その他

クライアント側アプリケーションで開発プロキシを使用する場合は、通常、追加の手順を実行する必要はありません。 開発プロキシを起動すると、マシンからのすべての要求が自動的にインターセプトされます。

ここに記載されていないテクノロジを使用して構築されたサーバー側アプリケーションで開発プロキシを使用する場合は、開発プロキシを使用するようにアプリケーションを構成するための追加の手順を実行する必要がある場合があります。 ネットワーク プロキシを使用するようにテクノロジを構成する方法については、テクノロジのドキュメントを参照してください。 ご質問がある場合は、Discord の Dev Proxy コミュニティ でヘルプを求めます。

URL を監視して開発プロキシを起動する

開発プロキシを起動し、アプリケーションが呼び出す API の URL を監視します。 たとえば、アプリケーションが にある https://api.contoso.com/v1/customersAPI を呼び出す場合は、開発プロキシを起動し、URL パターン https://api.contoso.com/*を監視します。

devproxy --urls-to-watch "https://api.contoso.com/*"

パラメーターは --urls-to-watch 、インターセプトを要求する Dev Proxy に指示します。 URL の末尾にあるワイルドカード * は、で始まる https://api.contoso.com/URL へのすべての要求をインターセプトするように Dev Proxy に指示します。

通常と同じように、アプリケーションの使用を開始します。 Dev Proxy は、指定した URL へのすべての要求をインターセプトします。 コマンド プロンプトに、Dev Proxy によって傍受された要求に関するメッセージが表示されます。

```text
 request     GET https://api.contoso.com/v1/customers
     api   ╭ Passed through
           ╰ GET https://api.contoso.com/v1/customers
 request     GET https://api.contoso.com/v1/customers
   chaos   ╭ 403 Forbidden
           ╰ GET https://api.contoso.com/v1/customers

重要

コマンド プロンプトにメッセージが表示されない場合は、開発プロキシを使用するようにアプリケーションを正しく構成していることを確認してください。 また、開発プロキシがアプリケーションで使用する API URL への要求をインターセプトしているかどうかをチェックします。 ご質問がある場合は、Discord の Dev Proxy コミュニティ でヘルプを求めます。

独自の構成ファイルを作成する

既定では、Dev Proxy は、その構成設定に Dev Proxy インストール フォルダー内のファイルを使用 devproxyrc.json します。 ファイルは、JSON プレースホルダー API のランダム エラーをシミュレートするように構成されています。 より現実的な結果を得るには、アプリケーションとそれが使用する API に関連するエラーを含む独自の構成ファイルを作成し、開発プロキシで使用します。

構成ファイルをアプリのプロジェクト フォルダーに格納して、構成設定をチームの他のユーザーと共有できるようにすることを検討しましょう。

1. Dev Proxy インストール フォルダーで、 と devproxy-errors.jsonをコピーdevproxyrc.jsonします。
2. プロジェクト フォルダーにファイルを貼り付けます。

Dev Proxy インストール ファイルの外部に格納されている構成ファイルを使用する場合は、参照が正しいことを確認する pluginPath 必要があります。 構成ファイル内の Dev Proxy インストール フォルダーへのパスをハード コーディングするのではなく、パスの先頭にある を使用 ~appFolder して、Dev Proxy インストール フォルダーへの動的参照を含めることができます。

1. テキスト エディターで、devproxyrc.json ファイルを開きます。
2. 配列内の GenericRandomErrorPlugin プラグインを plugins 見つけます。
3. を に更新しますpluginPath~appFolder/plugins/dev-proxy-plugins.dll。
4. 配列内の RetryAfterPlugin プラグインを plugins 見つけます。
5. を に更新しますpluginPath~appFolder/plugins/dev-proxy-plugins.dll。
6. コマンド プロンプトで、作業ディレクトリをプロジェクト フォルダーに変更します。
7. Enter キーを押 devproxy --config-file devproxyrc.json し、 Enter キーを押して、構成ファイルを使用して開発プロキシを開始します。
8. コマンド ラインから JSON プレースホルダー API に要求を送信し、出力を表示します。
9. CtrlCキー + を押して、開発プロキシを安全に停止します。

ヒント

Visual Studio Code 用 の Dev Proxy Toolkit 拡張機能をインストールすると、構成ファイルの作成と更新が簡単になります。

次のステップ

開発プロキシでは、より堅牢なアプリケーションの構築に役立つさまざまなシナリオがサポートされています。 さまざまな開発プロキシ機能を使用してアプリケーションを改善する方法については、ハウツー ガイドを参照してください。

ハウツー ガイドを調べる