API Designer のテキストエディターのプロジェクトのルートファイル

テキストエディターで作成する API 仕様プロジェクトや API フラグメントプロジェクトでは、1 つのファイルが常に「ルートファイル」として指定されます。 [Files (ファイル)] ペインでは、ルートファイルが [Root file (ルートファイル)] という表示ラベルが付けられた長方形で示されます。プロジェクトを Anypoint Exchange にパブリッシュすると、ルートファイルにより、プロジェクトのファイルを検証するパーサーのコンテキストが設定されます。

たとえば、RAML API 仕様プロジェクトに 2 つの仕様が含まれていて、それぞれの仕様では !include キーワードを使用して、異なる API フラグメントセットが設定されているとします。これは、プロジェクトにもあります。プロジェクトを Exchange にパブリッシュすると、プロジェクトのすべてのファイルがパブリッシュされます。ただし、Exchange はプロジェクトに含まれる仕様とファイルを検証する必要があります。ルートファイルがないと、Exchange は最初に解析するファイルや解析対象のファイルセットを確認できません。

別の例として、複数のフラグメントが含まれる API フラグメントプロジェクトをパブリッシュするとします。1 つは独立しており、フラグメントの残りのファイルはライブラリフラグメントとその連動関係です。プロジェクトでルートファイルが指定されていない場合、Exchange はファイルを適切に解析できません。この場合、独立したフラグメントをルートファイルとして設定し、そのファイルが単独で解析可能であることを Exchange に示すことができます。または、ライブラリファイルをルートファイルとして設定し、そのファイルから解析を開始して、独立したフラグメントに進む必要があることを Exchange に示すことができます。

API Designer の 2020 年 2 月 8 日リリースの前の作成されたプロジェクトをテキストエディターで初めて開く場合、ルートファイルを設定するように求められます。

テキストエディターの API 仕様プロジェクトのルートファイル

すべての API 仕様プロジェクトは、デフォルトルートファイルを使用して作成されます。プロジェクトに複数の仕様がある場合、ルートファイルを切り替えることができます。

デフォルトルートファイル

API 仕様プロジェクトを作成すると、デフォルトで作成されるファイルがルートファイルとして設定されます。

「Orders API」という名前の API 仕様プロジェクトのデフォルトルートファイル

1	RAML API 仕様プロジェクトの名前は `Orders API` です。
2	このデフォルトファイルは `orders-api.raml` という名前で、ルートファイルとして設定されています (すべての API 仕様プロジェクトにはルートファイルが必要であるため)。

複数の仕様が含まれる API 仕様プロジェクトのルートファイルの設定

仕様をプロジェクトにインポートすると、API Designer から、その仕様をプロジェクトのルートファイルとして設定するかどうかを尋ねられます。

API 仕様プロジェクトの任意の仕様をそのプロジェクトのルートファイルとして設定できます。たとえば、次の画像は 2 つの仕様が含まれているプロジェクトを示しています。

2 つの仕様が含まれている API 仕様プロジェクト。現在のルートファイルは、RAML バージョンの仕様です。

1	OAS バージョンのインベントリプロセス API 仕様。
2	RAML バージョンのインベントリプロセス API 仕様。このバージョンの仕様が現在ルートファイルとして設定されます。

現在ルートファイルでない仕様の右側にある 3 つのドットをクリックすると、その仕様をルートファイルとして設定するオプションが含まれるメニューが表示されます。

3 つのドットをクリックすると開くメニューの上部にある [Set as root file (ルートファイルとして設定) オプション。]

1	クリックするとファイルのアクションメニューが開く 3 つのドット。
2	アクションメニューの上部にある [Set as root file (ルートファイルとして設定)] オプション。

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

すべての API フラグメントプロジェクトは、デフォルトルートファイルを使用して作成されます。プロジェクトに複数のフラグメントがある場合、ルートファイルを切り替えることができます。

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

API フラグメントプロジェクトを作成すると、デフォルトで作成されるファイルがルートファイルとして設定されます。

「Retail Common」という名前の API フラグメントプロジェクトのデフォルトルートファイル。

1	RAML API フラグメントプロジェクトの名前は Retail Common です。
2	このデフォルトファイルは `retail-common.raml` という名前で、ルートファイルとして設定されています (すべての API フラグメントプロジェクトにはルートファイルが必要であるため)。

複数のフラグメントが含まれる API フラグメントプロジェクトのルートファイルの設定

フラグメントを API フラグメントプロジェクトにインポートすると、API Designer から、そのフラグメントをプロジェクトのルートファイルとして設定するかどうかを尋ねられます。

API フラグメントプロジェクトの任意のフラグメントをそのプロジェクトのルートファイルとして設定できます。たとえば、次の画像は 2 つのフラグメントが含まれていて、最初のフラグメントがルートファイルとして設定されているプロジェクトを示しています。

2 つのフラグメントが含まれている API フラグメントプロジェクト。

1	ルートファイルとして設定されているフラグメント。
2	もう一方のフラグメント。

現在ルートファイルでないフラグメントの右側にある 3 つのドットをクリックすると、そのフラグメントをルートファイルとして設定するオプションが含まれるメニューが表示されます。