RAML
RESTful API Modeling Language (RAML) は、RESTful API を定義する YAML ベースの言語です。RAML は RESTful API を広範に文書化する機能も提供し、ドキュメンテーションジェネレータツールがユーザードキュメンテーションを抽出して、これを PDF、HTML などの表示フォーマットに変換できるようにします。
 |
RAML 仕様バージョン 0.8 がサポートされています。
|
この操作は、API にアクセスし、RAML を使用して API が構築されているサービスに対して API 呼び出しを行うときに使用します。
RAML 操作の使用
ワークフローでこの操作を使用するには、ThingWorx Flow にこれを接続します。フローに接続するには、次の操作を行います。
1. 
をクリックし、「API 設計」ユーティリティの下にリストされている「RAML」操作をキャンバス上にドラッグし、この操作にマウスポインタを合わせて 
をクリックするか、この操作をダブルクリックします。「RAML」操作ウィンドウが開きます。
をクリックし、「API 設計」ユーティリティの下にリストされている「RAML」操作をキャンバス上にドラッグし、この操作にマウスポインタを合わせて をクリックするか、この操作をダブルクリックします。「RAML」操作ウィンドウが開きます。2. 必要に応じて、ラベル名を編集します。デフォルトでは、ラベル名は操作名と同じです。
3. 「ルートファイル URL」フィールドに、ルート RAML ファイルとその依存が含まれている ZIP ファイルをフェッチする URL を入力します。
4. 「ルートファイル名」フィールドに、フェッチする RAML ルートファイルの名前を入力します。
5. 「フェッチ」をクリックし、基礎となる API を設定します。
6. 「完了」をクリックします。
出力スキーマ
「RAML」操作は、以下の図に示すような出力スキーマを返します。
