次の方法で共有

開発プロキシ用語集

この用語集では、開発プロキシのドキュメント全体で使用される用語を定義します。

A

API シミュレーター

実際の API サーバーに接続せずに API の動作を模倣するツール。 開発プロキシは、応答のモック作成、エラーのシミュレート、待機時間の挿入を行うことができる API シミュレーターです。

C

混乱のテスト

予期しない状態を処理できることを確認するために、システムに意図的に障害を導入するテスト手法。 開発プロキシでは、ランダムな API エラーとエラーをシミュレートすることで、混乱のテストが可能になります。

構成ファイル

監視する URL、有効にするプラグイン、プラグイン固有の設定など、開発プロキシの動作を定義する JSON ファイル (devproxyrc.json)。 「 開発プロキシの構成」を参照してください。

E

エラー シミュレーション

API 呼び出しを行う方法は、アプリケーションがエラーを処理する方法をテストするために意図的に失敗します。 開発プロキシは、実際の API に要求を転送するのではなく、HTTP エラー応答を返すことによってエラーをシミュレートします。

I

Intercept

Dev Proxy が宛先に到達する前に HTTP/HTTPS 要求をキャプチャする場合。 インターセプトされた要求は、API に渡したり、変更したり、モック応答に置き換えたりすることができます。

L

遅延

要求の送信と応答の受信までの遅延時間。 開発プロキシは、ネットワークの低速状態やオーバーロードされた API をシミュレートするために、人工待機時間を挿入できます。

M

モック応答

実際の API に要求を転送するのではなく、Dev Proxy から返される定義済みの応答。 モックは、まだ存在しない API に対するテストや、予測可能な応答が必要な場合に役立ちます。

モック ファイル

モック応答定義を含む JSON ファイル (多くの場合、 mocks.json)。 各エントリは、URL パターンを応答本文、状態コード、およびヘッダーにマップします。

P

通過

開発プロキシが変更なしで実際の API に要求を転送する場合。 これは、要求がアクティブなプラグインと一致しない場合、またはプラグインがそれに対して動作しないことを決定した場合に発生します。

プラグイン

開発プロキシの機能を拡張するモジュール 式コンポーネント。 プラグインは、要求をインターセプトしたり、レポートを生成したり、ガイダンスを提供したりできます。 プラグインのアーキテクチャを参照してください。

Preset

一般的なシナリオ用の事前構築済みの構成ファイル。 プリセットはプラグインと設定を組み合わせて特定のタスクを実行します。 「 プリセット構成を使用する」を参照してください。

Proxy

クライアント アプリケーションと API サーバーの間に配置され、要求と応答をリレーするサーバー。 開発プロキシは、コンピューター上でローカル プロキシとして実行されます。

R

レート制限

API は、クライアントが一定期間に行うことができる要求の数を制限するために使用する手法です。 開発プロキシは、429 (要求が多すぎる) 応答を返すことによって、レート制限をシミュレートできます。 比較するスロットリング。

録音

後で分析するために API 要求と応答をキャプチャするプロセス。 開発プロキシでは、トラフィックを記録し、さまざまな形式にエクスポートできます。

記者

記録されたデータを Markdown、JSON、プレーン テキストなどの人間が判読できる形式に変換するプラグイン。 レポーターは、レポート プラグインの出力を処理します。

レポート プラグイン

記録された要求を分析し、API の使用状況、アクセス許可、またはベスト プラクティスに関するレポートを生成するプラグイン。

S

Schema

開発プロキシ構成ファイルの構造と検証規則を定義する JSON スキーマ ファイル。 スキーマは、それらをサポートするエディターで IntelliSense を有効にします。

シャドウ API

アプリケーションが使用するが、組織に正式に文書化または認識されていない API エンドポイント。 開発プロキシは、シャドウ API の検出に役立ちます。

T

スロットリング

負荷が高いため、またはリソースを保護するために API が意図的に速度を落としたり、要求を拒否したりする場合。 多くの場合、 レート制限と同じ意味で使用されますが、調整は通常、一時的な条件を意味しますが、レート制限は固定ポリシーです。

U

監視する URL

Dev Proxy が要求を監視する URL パターン。 これらのパターンに一致する要求のみがインターセプトされます。 パターンでは、 https://api.contoso.com/*などのワイルドカードがサポートされています。

W

時計

特定の URL への要求を監視するため。 開発プロキシは、構成した URL を監視し、一致する要求をインターセプトできます。

こちらも参照ください

  • Last updated on