1. Homepage
  2. Design Center
  3. API Designer

  4. API フラグメントの作成とパブリッシュ

API Designer のテキストエディターでの API フラグメントの作成およびパブリッシュ

テキストエディターに表示されるコード提案を参考にしながら、RAML、OAS 3.0、JSON スキーマで API フラグメントを直接作成することができます。

このタスクについて

API フラグメントは、バージョンと識別子を持ちながら、それ自身では完全な仕様ではないドキュメントです。
RAML API フラグメントを作成する場合、RAML.org で定義されている次のいずれかの種別になります。これらの種別の説明については、RAML 0.8 または 1.0 仕様 (使用する方) を参照してください。

  • 特性

  • リソース種別

  • ライブラリ

  • 型

  • ユーザードキュメント

  • 例

  • アノテーション種別

  • セキュリティスキーム

API フラグメントでは、OAS 3.0 フラグメントの外部化をサポートするために OAS 3.0 コンポーネントと JSON スキーマがサポートされています。

  • コンポーネント (YAML)

  • コンポーネント (JSON)

  • JSON スキーマ

OAS 3.0 コンポーネントには、OAS のさまざまな側面の再利用可能な​コンポーネント​オブジェクトのみが含まれている必要があります。

手順

  1. Design Center の ​[Projects (プロジェクト)]​ ページで、​[Create + (作成 +)]​ をクリックします。

  2. [New Fragment (新しいフラグメント)]​ を選択します。

  3. [New Fragment (新しいフラグメント)]​ ダイアログで、フラグメントプロジェクトの名前を入力します。

  4. API 仕様形式を選択します。

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

    RAML 1.0 を選択した場合、そのフラグメントタイプを選択できます。
    名前またはフラグメントタイプは必要に応じて後から変更できます。

  5. 作成する API フラグメントのタイプを選択し、​[Create Fragment (フラグメントを作成)]​ をクリックします。

    結果:​ テキストエディターが開きます。エディターは 3 つのパネルに分かれています。

    • 左側のパネルには、プロジェクトファイルのリストが表示されています。

      新しいファイルを作成するには、​[+]​、​[New file (新規ファイル)]​ の順にクリックします。ファイルの API 形式 (RAML 1.0、OAS 3.0、JSON スキーマなど) を選択します。必要に応じて、ファイル種別を選択し、ファイルに名前を付けて、​[Create (作成)]​ をクリックします。

      デフォルトでは、エディターはプロジェクトと同じ名前のファイルを作成します。このファイルは、プロジェクトのルートファイルとして設定されます。

      ルートファイルとして YAML、RAML、JSON スキーマファイルを設定できます。

      左側のパネルには、​exchange.json​ ファイルもリストされます。このファイルには、プロジェクトを Anypoint Exchange にパブリッシュするときに Exchange から要求されるメタデータが含まれます。このファイルは参照のみです。

    • 中央のパネルには、API フラグメントを作成するためのエディターがあります。

    • 右側のパネルには、中央のパネルに表示されている API フラグメントに含まれる型やリソースのリストが表示されます。

  6. API フラグメントを作成します。

    テキストエディターは、カーソル位置に挿入できる RAML ノード、メソッド、および他の要素を提案します。

    プロジェクトには、ファイルを 1 つずつ、または .zip ファイルにまとめてインポートできます。RAML 1.0 ファイル、JSON ファイル、OpenAPI Specification (OAS) 2.0、または OAS 3.0 ファイルがサポートされています。コンピューター上のローカルファイルを指定するか、またはファイルがオンラインで保存されている場合は URL を指定できます。

次のステップ

API フラグメントを Anypoint Exchange にパブリッシュすることができます。

  1. テキストエディターの右上隅にある ​[Publish (パブリッシュ)]​ ボタンをクリックして ​[Publish to Exchange (Exchange にパブリッシュ)]​ をクリックします。

  2. Exchange で​アセット​として処理されるプロジェクトのバージョン番号を指定します。この番号は、Exchange のプロジェクトのページの右側のペインにある ​[Version (バージョン)]​ セクションに表示されます。

Anypoint Exchange で API フラグメントプロジェクトのアセットバージョンが表示される場所は次のとおりです。

「Versions (バージョン)」 セクションの場所

API フラグメントプロジェクトをパブリッシュしたら、他の開発者はそのフラグメントを連動関係として独自の API 仕様プロジェクトに含めることができます。

API フラグメントプロジェクトをパブリッシュすると、その API Portal が自動的に作成されます。

関連情報