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

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

このタスクについて

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

  • 特性

  • リソース種別

  • ライブラリ

  • ユーザドキュメント

  • アノテーション種別

  • セキュリティスキーマ

手順

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

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

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

    名前またはフラグメントタイプは必要に応じて後から変更できます。

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

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

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

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

+ 左側のパネルには、​exchange.json​ ファイルもリストされます。このファイルには、プロジェクトを Anypoint Exchange にパブリッシュするときに Exchange から要求されるメタデータが含まれます。このファイルは参照のみです。 * 中央パネルには、API フラグメントを作成するためのエディタがあります。 * 右側のパネルには、中央パネルに表示されている API フラグメントに含まれる型やリソースのリストが表示されます。

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

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

    プロジェクトには、ファイルを 1 つずつ、または .zip ファイルにまとめてインポートできます。RAML 1.0 ファイル、JSON ファイル、OpenAPI Specification (OAS) 2.0 または 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 が自動的に作成されます。

Was this article helpful?

💙 Thanks for your feedback!