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

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

このタスクについて

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

  • 特性

  • リソース種別

  • ライブラリ

  • ユーザドキュメント

  • アノテーション種別

  • セキュリティスキーマ

手順

  1. Design Center の [Projects (プロジェクト)] ページで、[Create (作成)] をクリックして *[Create Fragment (フラグメントを作成)] *を選択します。

  2. [New API Fragment (新しい API フラグメント)] ダイアログで、プロジェクトの名前を入力して、作成する API フラグメントの種別を選択します。次に [Create (作成)]​をクリックします。

    結果: コードエディタが開きます。エディタは 3 つのパネルに分かれています。

    • 左側のパネルには、プロジェクトファイルのリストが表示されています。デフォルトでは、エディタはプロジェクトと同じ名前の .raml ファイルを作成します。

      1 つのプロジェクトでは複数の API 仕様を作成できます。プロジェクトに API 仕様を追加するには、[Files (ファイル)] パネルでプラス記号をクリックして新しいファイルを作成するか、またはプラス記号の横にあるドットをクリックしてファイルをインポートします。

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

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

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

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

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

次にすること

API フラグメントを Anypoint Exchange にパブリッシュすることができます。コードエディタの右上隅にある [Publish to Exchange (Exchange へのパブリッシュ)] ボタンをクリックして [Publish API specification to Exchange (Exchange への API 仕様のパブリッシュ)]​ダイアログを開きます。

パブリッシュしたフラグメントは、API 仕様プロジェクトに連動関係として含めることができます。フラグメントを変更した場合は、そのフラグメントを使用している API 仕様を更新して、新しいバージョンを含めてください。

API フラグメントを Exchange にパブリッシュすると、そのフラグメントの API ポータルが自動的に作成されます。

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub