このセクションでは、OpenAPI/Swagger 定義から仮想アセットを作成する方法について説明します。
セクションの内容:
概要
Virtualize は、OpenAPI/Swagger 定義で発見されたエンドポイントに基づいて .pva を作成することができます。OpenAPI/Swagger ウィザードによって生成された各 .pva には、定義されたすべてのエンドポイントに対するメッセージ レスポンダーがあります。この機能が特に役に立つのは、仮想化したいサービスがライブ記録で利用できないが、それを記述した定義ファイルにはアクセスできる場合です。
以下の使用がサポートされています。
- Swagger?1.0 - 2.0。これらの仕様と互換性がある Swagger Core のバージョンもサポートされます (たとえば Swagger Core 1.0.0、1.2.4、1.3.12、1.5.0-M1、1.5.0)。
- OpenAPI/Swagger 3.0
Virtualize の Swagger 機能を使用するには、Java 7 以降が必要です。Mac の場合は Java 8 以降が必要です。
定義ファイルからアプリケーションの振る舞いを仮想化するには、主に 2 つのステップがあります。
- 定義ファイルからメッセージ レスポンダーを作成する。
- 作成したメッセージ レスポンダーをデプロイする。
定義ファイルからのメッセージ レスポンダーの作成
OpenAPI/Swagger 定義からメッセージ レスポンダーを自動的に作成するには、次の操作を行います。
- 仮想アセットを右クリックし、[新規追加] > [仮想アセット (.pva) ファイル] をクリックします。★?
- ファイル名を指定し、[次へ] をクリックします。
- [REST] > [OpenAPI/Swagger] オプションを選択し、[次へ] をクリックします。
- ウィザードへのアクセスの詳細については「プロジェクト、 仮想アセット、レスポンダー スイートの追加」を参照してください。
- OpenAPI/Swagger ウィザード ページで、OpenAPI/Swagger 定義を発見する絶対 URI を入力するか、ローカル システムのファイルを参照します。
- [終了] ボタンをクリックします。
Virtualize は、OpenAPI/Swagger 定義中のリソース/メソッド/ステータス コードごとに 1 個のメッセージ レスポンダーを作成して設定します。 ?可能な場合、サンプル メッセージがレスポンスに含まれます。 ?サービス定義にスキーマがある場合、レスポンスを作成して従うためにスキーマが使用されます。 ?
コントロールを使ってレスポンス メッセージを指定できます。作成されるツールのオプションをレビューおよびカスタマイズする方法については、「?メッセージ レスポンダーの概要」を参照してください。
仮想アセットのデプロイ
.pva が VirtualAssets プロジェクトに直接作成される場合、仮想アセットは自動的にデプロイされます。そうでない場合、仮想アセットをデプロイする最も単純な方法は、VirtualAssets プロジェクトに .pva ファイルをコピーすることです。?
あるいは、[Virtualize サーバー] ビューの [ローカルマシン] ノードを右クリックし、[仮想アセットの追加] を選択します。デプロイしたい仮想アセットを含む .pva ファイルを指定して、[終了] をクリックします。ウィザードの入力を完了すると、 Virtualize は .pva ファイルを VirtualAssets プロジェクトに自動的にコピーします。
デプロイ手順とオプションの詳細については、「仮想アセットのデプロイ」を参照してください。
仮想アセットのカスタマイズ
メッセージ レスポンダーの振る舞いをカスタマイズする方法については、「メッセージ レスポンダーの概要」を参照してください。