REST プラグイン

このプラグインは、通信プラグイン開発用に提供されている C API のサブセットを、組み込み HTTP サーバーで提供される RESTful API の形で公開します。そのため、独自のアプリケーション固有のフロントエンドを作成して MERLIC RTE を制御することができます。

REST プラグインは、MERLIC RTE ステートマシンを調べ、ウェブブラウザから直接レシピの結果を監視できる組み込みのサンプルウェブアプリケーションを提供します。RESTful API のインタラクティブなドキュメントも組み込まれています。組み込みのウェブアプリケーションは、REST API をホストしているのと同じ HTTP サーバーを介して提供されますが、無効にすることもできます。

REST プラグイン自体の構成は、MERLIC RTE Setup で調整できます。

要件および制限

REST プラグインを使用する場合、以下の要件と制限が適用されます。

• カスタムアプリケーションから RESTful API を使用する際には、任意の HTTP クライアントライブラリを使用できます。
• 組み込みのウェブアプリケーションを使用するには、Mozilla Firefox、Google Chrome™、Microsoft Edge など最新のウェブブラウザが必要です。
• RESTful API を公衆インターネット上に公開すると、セキュリティ上のリスクが生じます。追加の対策を講じないと、REST プラグインとの間のすべてのトラフィックは、インターネットを通過する際に第三者によりプレーンテキストとして読み取られるリスクにさらされます。これは、リバースプロキシを使用し、TLS を適切に構成することで軽減できます。もう 1 つの重大なリスクは、RESTful API で公開される機能です。RESTful API へのアクセスは、信頼できるユーザーのみが利用できるようにする必要があります。このリスクは、適切な形式のユーザー管理を実装することで軽減できます。リスクを軽減するもう 1 つのオプションは、公衆インターネット経由で RESTful API を公開しないようにすることです。これは、サーバーとクライアントを仮想プライベートネットワーク (VPN) 内で機能させることによって実現できます。

詳しい説明