アセットの作成

Anypoint Exchange 非公開インスタンスまたは Exchange 公開ポータルで API、API グループ、ポリシー、サンプル、テンプレート、コネクタを共有するには、そのアセットタイプのアセットを作成します。

アセットの作成方法は、そのタイプによって異なります。

  • OAS、RAML、RAML フラグメント、HTTP、WSDL、カスタムアセットの場合、Exchange の [New asset (新規アセット)]​ メニューを使用してアセットを直接作成する。

  • サンプルまたはテンプレートの場合、Anypoint Studio の Maven 化機能を使用して各アセットを作成し、それぞれを Exchange にパブリッシュする。

  • コネクタ、ポリシー、サンプル、テンプレートについては、「Maven を使用した Exchange アセットのパブリッシュとデプロイ」​を参照。

  • Design Center を使用して API を Exchange にパブリッシュすることで、RAML、OAS または RAML フラグメントをパブリッシュすることも可能。

    これらのアセットタイプをパブリッシュする別の方法は、​Exchange Experience API​ を使用することです。

  • RAML および OAS API 仕様は、Anypoint Platform コマンドラインインターフェース (CLI)​ を使用して Exchange にアップロードできます。

    例: ​exchange asset upload --classifier raml --apiVersion v1 --name HelloWorld --mainFile helloworld.raml helloword/1.0.0 /Users/nmouso/Downloads/helloworld.raml.zip

  • API グループは、Anypoint API Manager から Exchange にパブリッシュする。

Exchange の各アセットはバージョン管理されています。非表示にするバージョンを非推奨にすることで、表示されるバージョンを管理できます。必要に応じて、バージョンを削除できます。

アセットバージョンに加えて、API にはアセットの詳細画面の上部に表示されるコンシューマ向けの API バージョンがあります。この API バージョンは API プロバイダによって定義されます。

Exchange のアセットバージョンは、メジャー、マイナー、およびパッチリリースの​セマンティックバージョンン設定​に従います。たとえば、アセットのバージョンが 2.4.6 でメジャーバージョンが 2.x.x である場合、そのマイナーバージョンは 2.4.x で、パッチバージョンは 2.4.6 になります。

アセットのマイナーバージョンを選択するには、アセットポータルの一番上にあるアセット名の横のメニューを使用します。アセットのパッチバージョンを選択するには、右側のバージョンリストを使用します。

2019 年 1 月 12 日​以降にパブリッシュされたすべての OAS アセットの RAML バージョンと、その日付以降にパブリッシュされたすべての RAML アセットの OAS 2.0 バージョンは自動的に生成されています。

Exchange では RAML フラグメントが完全にサポートされています。現在、Exchange では、OAS 3.0 コンポーネントを仕様内の Exchange 連動関係としてインポートおよび管理することはできません。

次の図は、各アセットタイプ (緑色) が Exchange でどのように表示されるかをまとめたものです。

ex2 exchange assets

アセット制限

Exchange では、パブリッシュできるアセットバージョンの数を制限してリソース枯渇攻撃を防ぎます。

この制限は、トライアルアカウントを使用しているマスタ組織では 500 アセット、他のマスタ組織では 100 000 アセットです。

このアセットのカウントには、削除されたアセットや Exchange によって生成されたアセット (API から自動的に生成された Mule 3 および Mule 4 コネクタなど)​ は含まれません。

マスタ組織の制限の 80% に達すると、Exchange に警告が表示されます。

マスタ組織の制限に達すると、Exchange にエラーが表示されます。また、ホームページの [New asset (新規アセット)]​ ボタンやアセット詳細ページの [Add new version (新規バージョンを追加)]​ ボタンを使用すると、制限に達したためにこれ以上アセットを追加できないことを示すエラーが表示されます。

次のような CURL コマンドを使用してマスタ組織の制限を確認します。

    curl -X GET \
      https://anypoint.mulesoft.com/exchange/api/v1/organizations/MASTER_ORGANIZATION_ID/limits \
      -H 'Authorization: bearer ANYPOINT_TOKEN'

MASTER_ORGANIZATION_ID​ を各自のマスタ組織 ID、ANYPOINT_TOKEN​ をマスタ組織の権限がある認証トークンに置き換えます。

次のような CURL コマンドを使用してアセットのリストを取得します。

    curl -X POST \
      https://anypoint.mulesoft.com/graph/api/v1/graphql \
      -H 'content-type: application/json' \
      -H 'Authorization: bearer ANYPOINT_TOKEN' \
      -d '{"query":"{assets(query: { masterOrganizationId:\"MASTER_ORGANIZATION_ID\", limit: 20, offset: 10 }) {groupId assetId version}}"}'

MASTER_ORGANIZATION_ID​ を各自のマスタ組織 ID、ANYPOINT_TOKEN​ をマスタ組織の権限がある認証トークンに置き換えます。必要に応じて、limit​ および offset​の値を変更します。

アセットの検索についての詳細は、「Graph API を使用した検索」​を参照してください。

API アセットを作成する

API アセットでは、インターフェースのすべて (その関数、説明、戻りコードの処理方法、連動関係など) を指定します。

API アセットを作成する手順は、次のとおりです。

  1. Exchange で、[New asset (新規アセット)]​ を選択します。

  2. アセットポータル名を入力します。

  3. ドロップダウンリストから、アセットタイプを選択します。

    • REST API - RAML: RAML API 仕様ファイルを提供します。RAML 仕様には RAML ファイル (.raml) を使用する必要があります。

    • REST API - OAS: OAS API 仕様ファイルを提供します。OAS 仕様には YAML (.yaml) または JSON (.json) ファイルを使用できます。Exchange では、OAS 2.0 および OAS 3.0 仕様がサポートされています。

    • SOAP API - WSDL: WSDL API 仕様ファイルを提供します。SOAP 仕様ファイルには WSDL (.wsdl) または XML (.xml) ファイルを使用できます。

    • API 仕様フラグメント - RAML : API フラグメント RAML 仕様ファイルを提供します。フラグメント仕様には RAML ファイル (.raml) を使用する必要があります。

    • HTTP API - このアセットはファイルを必要としません。このタイプのアセットでは、API Manager によって定義された API エンドポイントを提供します。

  4. RAML、API 仕様フラグメント、OAS、WSDL アセットの場合、次の操作を実行します。

    1. [Choose File (ファイルを選択)]​ を選択し、API 仕様ファイルを見つけます。

    2. API のメインファイルを選択します。ファイルが zip の場合、メインファイルは zip 内のルートディレクトリにある必要があります。ファイルが zip ファイルではない場合、またはメインファイルが 1 つのみの場合は、自動的に選択されます。

  5. (省略可能) [Advanced (詳細)]​ を選択して、詳細設定 (GroupId​、AssetId​、バージョン​、API バージョン​) を編集します。. グループ ID、アセット ID、バージョンは Exchange によって自動的に生成されますが、これらの値はここで変更できます。API アセットのバージョン (アセットバージョン) と API バージョンは個別に変更できます。詳細設定は、アセットバージョンを変更する場合に頻繁に使用されます。

  6. [Publish (パブリッシュ)]​ を選択します。

API グループアセットの作成

API グループは、組織で API インスタンスのグループを単一ユニットとしてパブリッシュできるようにするアセットです。これにより、開発者のクライアントアプリケーションは、1 つのクライアント ID と必要に応じてクライアントシークレットを使用して API にグループとしてアクセスできます。

API グループは、Anypoint API Manager で作成して、Exchange にパブリッシュします。

API グループには、1.0.0、2.0.0、3.0.0 などのメジャーバージョンはありますが、マイナーバージョンやパッチバージョンはありません。API グループの各バージョンには、1 つ以上の API グループインスタンスがあります。各 API グループインスタンスは、ID プロバイダと環境種別 (本番または Sandbox) がすべて同じである API インスタンスのグループです。API グループインスタンスには、複数のビジネスグループの API インスタンスを含めることができます。

API グループを作成する場合、グループの API ごとにグループ管理者ロールとアセット管理者ロールが必要になります。これにより、グループ作成者は非公開表示レベルと公開表示レベル間で基礎となる API を変更できます。

API グループに非公開 API がある場合、API グループを公開ポータルにパブリッシュするときに警告が表示されます。非公開コンテンツは、公開ポータルに表示されません。API グループのすべてのコンテンツが公開ポータルにパブリッシュされるようにするには、Exchange で各 API のページに移動し、API を公開してから API グループをパブリッシュします。

すべての API グループインスタンスが非公開である場合に API グループを公開ポータルにパブリッシュしたときや、すべての API インスタンスが非公開である場合に API グループインスタンスを公開したときも警告が表示されます。

カスタムアセットの作成

カスタムアセットでは、お知らせ、ドキュメント、動画、ファイルの共有など、組織のあらゆる側面に関する情報を共有できます。ユーザがダウンロードできる省略可能なファイルをカスタムアセットに追加できます。ファイルは Exchange に保存されます。

注意:​ Exchange では、カスタムアセットの省略可能なファイルとして次のファイルの種類のみを使用できます。

画像: ​.jpg, .jpeg, .png, .gif, .svg
ドキュメント: ​.docx, .pdf, .pptx, .rtf, .vsdx, .vssx
圧縮ファイル: ​.zip, .tgz, .jar, .gz, .7z
テキストファイル: ​.txt, .json, .raml, .yaml, .yml, .md, .csv, .xml, .xsd, .wsdl, .html, .pom, .log, .sql

ファイルの種類がないファイルは使用できません。すべてのファイルの種類は大文字と小文字を区別しません。

SVG ファイルは 100 KB 以下に制限されます。

許可されていない種別のファイルを含むすべての古いカスタムアセットを削除することをお勧めします。サポートされていないファイルを含むカスタムアセットの場合、そのアセットを削除してファイルを削除します。

カスタムアセットを作成する手順は、次のとおりです。

  1. Exchange で、[New asset (新規アセット)]​ を選択します。

  2. アセットポータル名を入力します。

  3. ドロップダウンリストから、[Custom (カスタム)]​ アセットタイプを選択します。

  4. (省略可能) ファイルをユーザと共有するには、そのファイルを選択します。

  5. (省略可能) [Advanced (詳細)]​ を選択して、詳細設定 (GroupId​、AssetId​、バージョン​) を編集します。. グループ ID、アセット ID、バージョンは Exchange によって自動的に生成されますが、これらの値はここで変更できます。詳細設定は、アセットバージョンを変更する場合に頻繁に使用されます。

  6. [Publish (パブリッシュ)]​ を選択します。

アセット名、アイコン、説明のプロパティ

API Designer または Exchange でアセットを作成できます。名前、アイコン、説明のプロパティは、アセットの作成後に「アセットの説明」​の説明に従って Exchange のアセット詳細ページでのみを変更できます。

API Designer で作成されたアセットのプロパティ

API Designer は、RAML 仕様のアセットの名前を読み取って使用します。

Exchange でアセットをパブリッシュする前に、API Designer で名前を編集できます。

Exchange でアセットがパブリッシュされると、この名前がアセットポータル名として使用されます。Exchange のアセットのバージョンを更新するために API Designer からパブリッシュする場合、名前項目が無効になり、Exchange の名前が表示されます。名前、アイコン、説明のプロパティは、Exchange のアセット詳細ページでのみを変更できます。

Exchange で作成されたアセットのプロパティ

Exchange でアセットを作成するときに、名前を入力します。

Exchange で新しいバージョンを追加するときに名前を変更することはできません。

名前、アイコン、説明のプロパティは、Exchange のアセット詳細ページでのみを変更できます。

既存のアセットの新しいバージョンを作成する

アセットへのコントリビュータまたは管理者アクセス権がある場合、アセットポータルから新しいバージョンを追加できます。

  1. Exchange で、アセットリストを開き、アセットを選択します。

  2. サイドバーの [Versions (バージョン)]​ テーブルで、[Add New Version (新規バージョンを追加)]​ を選択します。

  3. [Version (バージョン)]​ (アセットバージョン) を入力します。

  4. (省略可能)[API version (API バージョン)]​ を入力します。

  5. (省略可能) アップロードするファイルを選択します。

  6. [Publish (パブリッシュ)]​ を選択します。

アセットの新しいバージョンの名前、アイコン、説明は、以前のバージョンと同じになります。これらのプロパティに対する変更は、アセットのすべてのバージョンに適用されます。

Was this article helpful?

💙 Thanks for your feedback!