USER MANUALS

JSON ソース

新しい JSON データソースを作成するには、[Server Explorer] で右クリックして [New] > [Data source] > [JSON] の順にクリックします。

データソースを作成するためのダイアログが表示されます。

Creating a JSON data source

JSON データソースの作成

このダイアログでは、以下のデータを指定する必要があります。

  • Name: 新しいデータソースの名前。

  • Endpoint access configuration:データへのアクセスは、以下の 2 つのオプションで構成します。

    • Direct:データを含む JSON ファイルへのパスを入力します。

    • From OpenAPI 3 document:サービスの操作が定義されている OpenAPI 3 ドキュメントへのコネクションの詳細を構成します。これらのドキュメントから基本ビューが作成されます。

  • Ignore route errors: チェックすると、データソースで参照されているファイルにアクセスしたときに発生したエラーが、Virtual DataPort サーバーによって無視されます。

    このオプションは、データソースで読み取るファイルが 1 つのみの場合に使用することを意図したものではありません。このオプションを使用する主な状況は、データソースが複数のファイルを参照していて、その一部は存在しない可能性があることがわかっている場合です。たとえば、 /opt/application/logs/log-^DateRange("yyyy/MM/dd",@start_date,@end_date,"yyyy-MM-dd").json をローカルパスとする一連のログファイルを読み込む JSON データソースを作成できます (DateRange 関数の詳細については、「 日付範囲を使用したパス 」を参照)。

    このデータソースから作成した基本ビューにクエリを実行すると、そのデータソースではすべてのログファイルを順番に読み取ります。たとえば、クエリで条件として start_date='2018/05/01' AND end_date = '2018/05/04' を指定した場合、データソースは log_2018-05-01.json、log_2018-05-02.json、log_2018-05-03.json、および log_2018-05-04.json の各ファイルを読み取ろうとします。これらのファイルのいずれかが存在しない場合、このクエリは失敗します。

    このエラーを無視する場合は、[Ignore route errors] チェックボックスをチェックします。このようにすると、ファイルのいずれかが存在しない場合や読み取ることができない場合、そのファイルは無視され、次のファイルが読み取られます。管理ツールからこのクエリを実行すると、読み取ることができなかったファイルを [Execution trace] で特定できます。そのためには、このトレースで、「 Type = Route 」と表示されているノードをクリックします。読み取ることができなかったファイルには、 Exception 属性の後にエラーメッセージが表示されています。

[Metadata] タブで以下の操作を実行できます。

  • データソースが保存されるフォルダを設定します。

  • 説明を入力します。

  • データが保存されるインフラストラクチャ情報を設定します。インフラストラクチャのプロバイダー名 (オンプレミス、Amazon Web Services、Microsoft Azure、Google Cloud Platform など) とリージョン名を設定できます。プロバイダー名やリージョンがリストにない場合は、カスタム名を入力できます。

データソースを編集する際、 image1 ボタンをクリックすると、その所有者も変更できます。

[Save] をクリックして、データソースを作成します。

Direct

[Direct] 構成を使用する場合、[Data route] を構成する必要があります。これは、データを収めた JSON ファイルへのパスです。このパスは、補間変数を使用することで、作成したクエリに応じてパラメータ化できます (「 補間変数によるパスなどの値 」を参照)。使用可能なパスの形式と、そこでパラメータを使用する方法については、「 Virtual DataPort でのパスの種類 」を参照してください。この場合に最も広く使用するパスのタイプは、 HTTP クライアント です。

データソースを作成した後、[Create base view] をクリックして、基本ビューの作成を開始します。選択したパスタイプが [HTTP client] である場合、[Configure JSON base view] ダイアログが開きます。ここで、作成する基本ビューの相対ルートを構成できます。

Configuring JSON base view

JSON の基本ビューの構成

このダイアログには、以下のフィールドが表示されます。

  • Configuration:

    • HTTP Method:基本ビューが実行する HTTP メソッド。

    • Base URL:データソースの URL (例:http://www.library.com/)。このフィールドは変更できません。

    • Relative URL:基本ビューの相対 URL (例:「/books」)。基本ビューを実行する際にこの URL が [Base URL] に連結されます (生成される URL は http://www.library.com/books になります)。

    • HTTP headers:基本ビューの URL ヘッダー。基本ビューの実行時に URL に適用されます。

  • Pagination:基本ビュー URL の改ページ設定。

  • Filters:基本ビュー URL のフィルタ設定。

これにより、基本 URL (http://www.library.com/) を定義するデータソースを再利用して、アクセスするリソースごとに固有の相対 URL (「/books」、「/authors」、「/bookById/{id}」など) を使用して基本ビューを作成できます。

基本ビューのルートを構成して [Ok] をクリックすると、[Configure JSON Wrapper] ダイアログが表示されます。[HTTP client] 以外のパスタイプを選択している場合、[Create base view] をクリックした直後に [Configure JSON Wrapper] ダイアログが表示され、上で説明しているダイアログ ([Configure JSON base view]) は表示されません。

アクセスする必要があるのが JSON ドキュメントの一部のみである場合、[Configure JSON Wrapper] ダイアログで基本ビューの「タプルルート」を変更できます。[JSON root] チェックボックスをチェックしたままにして [Ok] をクリックすることが推奨されます。

Creating a JSON base view

JSON の基本ビューの作成

データファイルへのパスに補間変数を使用している場合、それらの変数の値を指定するための中間ステップがあります。「 補間変数によるパスなどの値 」を参照してください。

このステップの後、新しい基本ビューのスキーマが表示されます。この段階で、以下の処理が可能です。

  • ビューの名前を変更する。

  • 各フィールドの名前をダブルクリックして変更し、その型を右側のドロップダウンリストから選択する。

  • 新しいビューのプライマリキーを設定する (「 ビューのプライマリキー 」を参照)。

  • [Metadata] タブで基本ビューの格納先フォルダを設定し、その説明を記述する。

  • 基本ビューを編集する際、 image1 ボタンをクリックして、その所有者を変更する。

次に、[Save] (image3) をクリックして、基本ビューを作成します。

[Server Explorer] で新しい基本ビューのスキーマを表示するには、そのビューをダブルクリックします (「 派生ビューの作成 」を参照)。基本ビューを変更するには [Edit] をクリックします。

From OpenAPI 3 Document

このオプションは、OpenAPI 3 ドキュメントから基本ビューを作成します。ドキュメントへのルートを構成する必要があります。ルートは、[Local file] であるか、または [HTTP server] でアクセス可能です (HTTP Basic 認証または HTTP ダイジェスト認証を使用)。

OpenAPI 3 ドキュメントへのアクセスを指定した後、[Configuration]、[Pagination]、[Proxy]、[Authentication]、および [Filters] の各パラメータを構成できます。この Open API データソースから作成された基本ビューは、実行時にデフォルトでこの構成の値を使用します。

Creating an Open API data source

Open API データソースの作成

[Load default values from OpenAPI3 Specification] ボタンをクリックすると、[Configuration] タブの [Base URL] フィールドに、OpenAPI 3 ドキュメントで指定されている URL が自動的に入力されます。この [Base URL] は、OpenAPI 仕様の操作のエンドポイントが連結されるアドレスです。

たとえば、ドキュメントで定義されている API サーバーが https://www.library.com/ である場合、これがベース URL になります。次に、エンドポイントが「/books」である操作に対して基本ビューを作成した場合、このビューを実行すると、エンドポイントがベース URL に連結され (https://www.library.com/books というアドレスが生成される)、データソースで定義されている構成 (認証、ページング、プロキシなど) が使用されます。

Open API データソースの詳細については、「 OpenAPI 3 のデータソースの FAQ 」を参照してください。

Add feedback