1. Homepage
  2. Design Center
  3. API Designer

  4. API 仕様プロジェクトへのファイルのインポート

API 仕様プロジェクトへのファイルのインポート

RAML フラグメント、OAS コンポーネント、JSON スキーマを API 仕様プロジェクトにインポートできます。

1 つの API 仕様プロジェクトに複数の API 仕様を含めることができます。機能が関連した複数の仕様であれば 1 つのプロジェクトで管理することが望ましい場合もあります。いずれかの仕様をプロジェクトのルートファイルとして設定する必要があります。ただし、ルートファイルは必要なときにいつでも変更できます。

インポートするフラグメントは、RAML 0.8、RAML 1.0、OAS 3.0 で記述できます。アノテーション種別、データ型、JSON 応答ペイロードの例、ライブラリ、リソース種別、セキュリティスキーム、および特性をインポートできます。

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

手順

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

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

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

    3. ファイルまたは ZIP ファイルを参照して選択します。

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

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

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

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

      • URL を指定してオンラインで提供されているファイルをインポートする場合は、ファイルに ​!include​ ステートメント (RAML) または ​$ref​ ステートメント (OAS) が含まれていないように注意してください。エディターは、URL の場所にあるファイルのみをインポートします。

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

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

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

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

      • テキストエディターを使用している場合、テキストエディターの右上隅にある歯車アイコンをクリックして ​[Import from Exchange (Exchange からインポート)]​ を選択できます。

      • ビジュアルエディターを使用していて、プロジェクトにリソースやデータ型がまだ含まれていない場合、​[New API (新しい API)]​ ペインに表示されているリンクテキストをクリックできます。

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

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

      Name (名前)

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

      Version (バージョン)

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

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

      Type (種別)

      アセットの種別。

      値は ​[REST API]​ または ​[API Fragment (API フラグメント)]​ のいずれかです。

      Language (言語)​ (テキストエディターにインポートされる API 仕様の言語)

      言語は RAML または OAS のいずれかです。

      デフォルトで表示される値は、仕様の記述に使用された言語です。デフォルト以外の値は、仕様がパブリッシュされたときに Exchange でコピーを作成するために使用された言語です。

      コピーをインポートする必要がある場合、インポート後にコピー内のエラーの修正が必要になることがあります。Exchange でコピーを作成するために使用されるプロセス (RAML から OAS またはその逆への変換) で、エラーのない仕様が作成される保証はありません。

      Language (言語)​ (ビジュアルエディターにインポートされる API 仕様の言語)

      言語は常に RAML です。

      API Designer では、仕様の RAML バージョンがインポートされ、RAML バージョンが ​[RAML]​ ペインに、OAS バージョンが ​[OAS]​ ペインに表示されます。

      Language (言語)​ (フラグメントの場合)

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

      Date modified (変更日)

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

      Created by (作成者)

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

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

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

関連情報