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