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

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

前提 条件

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

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

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

JavaScript

Dev Proxyを使用する場面は、次の通りです。

• 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/customersにある API を呼び出す場合は、開発プロキシを起動し、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 に指示します。

通常どおりにアプリケーションの使用を開始します。 開発プロキシは、指定した URL に対するすべての要求をインターセプトします。 コマンド プロンプトに、開発プロキシがインターセプトする要求に関するメッセージが表示されます。

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

構成ファイルをアプリのプロジェクト フォルダーに格納して、構成設定をチームの残りの部分と共有できるようにすることを考えてみましょう。

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

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

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

アドバイス

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

次の手順

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

使い方ガイドを探る