新しいREST APIメタデータをファイルから作成
手順
-
Integrationパースペクティブの[Repository] (リポジトリー)ツリービューで、[Metadata] (メタデータ)ノードの下にある[REST API Definitions] (REST API定義)ノードを右クリックし、コンテキストメニューから[Create API definition] (API定義を作成)を選択します。
[Import API definition] (API定義のインポート)ウィザードが開きます。
-
[Import from file] (ファイルからインポート)を選択し、ローカルのREST APIファイルに移動します。
APIの自動検証が実行されます。ファイルが有効な場合は、[Next] (次へ)ボタンと[Finish] (終了)ボタンが有効になります。検証に失敗すると、次へ進むことができません。ただし、検証で警告のみが表示された場合は、このダイアログに表示されるリンクを使用して警告の内容を確認し、警告に従って次へ進んでよいかどうかを判断してください。ほとんどのユースケースでは警告は該当せず、注意を払う必要のある情報を示しているだけあり、ダイアログから[Next] (次へ)と[Finish] (終了)のアクションへ進むことができます。
-
[Next] (次へ)をクリックして、APIのコンテンツが自動的に入力されるAPI定義のプロパティを表示します。
フィールド
説明
[Name] (名前)
API定義の名前。このフィールドは編集可能です。
禁止文字を入力すると、メッセージが表示されます。
[Purpose] (目的)
目的、またはAPI定義に関する有用な情報。このフィールドは編集可能です。
[Description] (説明)
処理内容や動作のしくみのわかりやすい情報が含まれるAPI定義の説明。このフィールドは編集可能です。
[Author] (作成者)
デフォルトで現在のユーザーログインを表示する、読み取り専用のフィールドです。
[Locker] (ロック保持者)
デフォルトで現在のジョブのロックを保持しているユーザーがログインしていることを示す読み取り専用のフィールドです。このフィールドはAPIを作成する時は空で、既存のAPIのプロパティを編集する時のみデータが存在します。
[Version] (バージョン)
読み取り専用のフィールドです。[M]および[m]ボタンを使用して、手動でバージョンを高くできます。
[Status] (ステータス)
作成中のジョブのステータスから選択するリストです。
[Path] (パス)
API定義が作成されるフォルダーから選択するリスト。
-
[Finish] (終了)をクリックし、作成を確定してウィザードを閉じます。
作成したAPI定義は、[Repository] (リポジトリー)ツリービューの[Metadata] (メタデータ) > [REST API Definitions] (REST API定義)ノードの下にリスト表示されています。
コンテキストメニューから、以下のことができます。- [Edit API definition] (API定義の編集): API定義のプロパティを編集する。
- [Update API definition] (API定義のアップデート): アップデートを使用して、API定義の新バージョン/アップデートバージョンを取得する。