Websocketの定義にRAMLを使用する

Websocket（WS）を記述するために、RAMLファイルを変更できます。これにより、 APIスキャンでWebsocketの定義をスキャンし、 Tosca Commander にエクスポートできるようになります。例えば、「 API モジュールを更新」機能を使用することで、モジュールのメンテナンス作業を軽減できます。

RAMLによるWS記述の作成

RAMLでWS記述を作成するには、ファイルのbaseURIとメソッドを調整する必要があります。ただし、RAMLファイルを要件に応じてさらに調整することができます。

baseURI は RAML のオプション・フィールドで、APIとそのリソースのサービスエンドポイントを指定するために使用できます。メソッドは、リソースの送信など、リソースをどのように処理するかを定義します。

RAMLでWS記述：

• 「 baseURI 」フィールドにWSエンドポイントを入力します。例 ws://localhost/stream 。

• RAML定義でWSメソッドを使用します。例：「送信」、「受信」、「接続」。

以下の例は、WSを記述するためにRAMLファイルを修正する方法と、ファイルをスキャンした後に API Scan で表示する方法を示しています。API Scan は、RAMLファイルのbaseURIとメソッドを特定し、HTTPからWSに自動的に切り替えます。

これで、 API Scan でこれらのメッセージを実行し、 Tosca Commanderにエクスポートできるようになりました。