クライアントリクエスト

www.altova.com このトピックを印刷 前のページ 1つ上のレベル 次のページ

ホーム >  サーバー API: HTTP、COM/.NET、Java > HTTP インターフェイス >

クライアントリクエスト

RaptorXML+XBRL Server が サービスとして開始 されると、すべての HTTP クライアント から、以下を行うことのできる機能をアクセスすることができます:

 

HTTP メソッド GET、PUT、POST、 および DELETE を使用します。
Content-Type ヘッダーフィールドの設定

 

 

使用しやすい HTTP クライアント

インターネットからダウンロードすることのできる多数の Web クライアントがあります。使用しやすく安定した、 Web クライアントは、 Firefox のプラグインとして追加することのできる Mozilla の RESTClient です。 インストールしやすく、 RaptorXMLが必要とする HTTP メソッド をサポートし、十分な JSON 構文の色分けを提供します。 HTTP クライアントの経験が無い場合、 RESTClient を試してください。 RESTClient  のインストールと使用はユーザー自身の責任において続行してください。

 

 

典型的なクライアントリクエストは、下の図に表示されるように一連のステップから構成されています。

RaptorHTTP

各ステップの重要な点は下に説明されています。 主要な用語は太字で表記されています。

 

1.リクエストの本文がJSON フォーマットである HTTP POST メソッド はリクエストの作成に使用されます。 リクエスト は RaptorXML+XBRL Server の全ての機能に対して使用できます。例えば、 リクエストは検証、XSLT 変換 等に使用することができます。リクエスト内で使用される、コマンド、 引数、 およびオプション はコマンドライン内で使用されるものと同様です。リクエストは以下にポストされます: http://localhost:8087/v1/queue。 localhost:8087 が RaptorXML+XBRL Server (サーバーの初期設定アドレス) のアドレスと仮定されます。 リクエストは、 RaptorXML+XBRL Server ジョブ と称されます。

 

2.RaptorXML+XBRL Server によりリクエストが受信され、処理が受け付けられると、ジョブが処理された後、 サーバーアクションの結果を含む結果ドキュメント が作成されます。 結果ドキュメント URI は、(上の図の Result-Doc-URI ) クライアントに帰されます。処理が完了していなくても、ジョブが処理のために受け付けられると(キューに並べられると) URI が即時に返されることに注意してください。

 

3.( URI 使用して結果ドキュメントを使用する場合、) クライアントは サーバーへの GET メソッド内で、 結果ドキュメントのためにリクエストを送信します。 リクエストの受信時、ジョブの処理が開始されていない、または完了していない場合、 サーバーは実行の状況を返します。 GET リクエストは、ジョブの処理が完了し、結果ドキュメントか作成されるまで、繰り返されなければなりません。

 

4.RaptorXML+XBRL Server は、結果ドキュメントを JSON フォーマットで返します。 結果ドキュメントは、元のリクエストの RaptorXML+XBRL Server 処理により、作成された エラーの URI または、 出力ドキュメント を含む可能性があります。 エラーログが返されます。 例えば、検証がエラーを返す場合があります。XSLT 変換の結果などの プライマリ出力ドキュメントは、出力作成ジョブに成功した場合返されます。
5.クライアントは、サーバーへの HTTP GET メソッド を介して、ステップ 4 で受信した、 出力ドキュメントの URI を送信します。 各リクエストは個別の GET メソッドで送信されます。

 

6.RaptorXML+XBRL Server は、 ステップ 5 で作成された GET リクエストに応答して、リクエストされたドキュメントを返します。

 

7.クライアント は、ジョブリクエストの結果として生成された、サーバー上の必要のない ドキュメントを削除することができます。 これは、結果ドキュメントの URI 内の HTTP DELETE メソッドを送信することにより行えます。 これは、一時的なファイルおよびエラー、出力ファイルなどを含みます。このステップは、ハードディスクのスペースを解放するために役に立ちます。

 

各ステップの詳細に関してはこのセクションのサブセクションで説明されています。

 


(C) 2019 Altova GmbH