API フラグメントプロジェクトへのファイルのインポート

RAML フラグメント、OAS コンポーネント、JSON スキーマを API フラグメントプロジェクトにインポートできます。インポートするフラグメントは、RAML 0.8、RAML 1.0、OAS 3.0 で記述できます。アノテーション種別、データ型、JSON 応答ペイロードの例、ライブラリ、リソース種別、セキュリティスキーム、特性、OAS コンポーネントをインポートできます。プロジェクトのいずれかのフラグメントをプロジェクトのルートファイルとして設定する必要があります。

インポート元の場所として、自分のコンピューター、URL、Anypoint Exchange の 3 つがあります。

手順

  • テキストエディターを使用している場合、コンピューターに保存されているファイルまたは ZIP ファイルのコンテンツをインポートします。

    1. テキストエディターの右上隅にある歯車アイコンをクリックして ​[Import (インポート)]​ を選択します。

    2. [Import (インポート)]​ ダイアログで、​[File or Zip (ファイルまたは Zip)]​ を選択します。

    結果:​ エディターの左側のペインにファイルのリストが表示されます。インポートした ZIP ファイルに、フォルダー構造内のファイルが含まれる場合、ペインにそのフォルダー構造が表されます。

  • テキストエディターを使用している場合、URL を介して使用可能なファイルをインポートします。

    1. テキストエディターの右上隅にある歯車アイコンをクリックして ​[Import (インポート)]​ を選択します。

    2. [インポート]​ ダイアログで、​[URL]​ を選択します。

      結果:​ エディターの左側のペインにファイルが表示されます。

      このファイルのインポートの方法では、一度に 1 つのファイルのみをインポートできます。ライブラリフラグメントをインポートする場合、ライブラリで使用する各ファイルも個別にインポートする必要があります。

  • API フラグメントをその連動関係と共に Exchange からインポートする手順は、次のとおりです。

    1. 次のいずれかの方法を使用して、​[Import Asset from Exchange (Exchange からアセットをインポート)]​ ダイアログを開きます。

      • API Designer でプロジェクトと共に作成されたデフォルトファイルのみがプロジェクトに含まれる場合、​[Files (ファイル)]​ ペインに表示されているリンクテキストをクリックします。

      • プロジェクトにデフォルトプロジェクトファイル以外のファイルがすでに含まれている場合、テキストエディターの右上隅にある歯車アイコンをクリックして ​[Import from Exchange (Exchange からインポート)]​ を選択できます。

    2. ダイアログの左上隅にあるドロップダウンメニューで、アセットを所有するビジネスグループを選択します。

    3. 次の列を持つテーブルに表示されているいずれかのアセットを選択します。

      Name (名前)

      API 仕様または RAML フラグメントの名前。

      Version (バージョン)

      仕様またはフラグメントのバージョン。

      ダイアログの左下隅にある ​[Include snapshots (スナップショットを含める)]​ チェックボックスをオンにすると、この列にスナップショットが含まれます。

      Type (種別)

      アセットの種別。

      値は ​[API Fragment (API フラグメント)]​ である必要があります。

      Language (言語)

      RAML、OAS、JSON スキーマのいずれかを選択できます。

      Date modified (変更日)

      現在選択されているアセットの現在選択されているバージョンがパブリッシュされた日付。

      Created by (作成者)

      現在選択されているアセットの現在選択されているバージョンをパブリッシュしたユーザーのユーザー ID。

    4. [Import asset (アセットをインポート)]​ をクリックします。

    結果:​ エディターの左側のペインにファイルのリストが表示されます。