CLI を使用した API の作成

アダプターをプロビジョニングした後で、API を作成してサービスをバインドする必要があります。API は Anypoint Platform または Anypoint Service Mesh を使用して作成できます。

  • Anypoint Platform を使用して API を作成する

    API 仕様ファイルが 550KB より大きい場合に Anypoint Platform を使用して API を作成します。REST API または OAS アセットタイプをアップロードする場合は、​.json​、​.raml​、​.zip​、または ​.yaml​ ファイルを使用します。SOAP API または WSDL アセットタイプをアップロードする場合は、​.wsdl​ または ​.xml​ ファイルを使用します。

  • Anypoint Service Mesh の Autocreate 機能を使用した API の作成

    Anypoint Platform で API を自動的に作成するように Anypoint Service Mesh を設定できます (手動でのロギングは不要です)。REST API や SOAP API など、仕様ファイルを必要とする API を作成する場合は、CLI がアップロードできるように、仕様ファイルが 550KB を超えず、ファイルシステムで利用できることを確認してください。

Anypoint Platform を使用して API を作成する

Anypoint Platform を使用して API を作成するには、次の手順を実行します。

  1. [Anypoint Platform] > [API Manager]​ に移動し、​[Manage API (API を管理)]​ ドロップダウンリストを選択します。

  2. [Create new API (新しい API を作成)]​ を選択します。

    [Creating an asset (アセットの作成)] ページが表示されます。

  3. API の ​[Name (名前)]​ の値と ​[Asset types (アセットタイプ)]​ の詳細を指定します。

    アセットは再利用するため Exchange で作成されるようになりました。アセットを作成したら、エンドポイント設定を行う準備ができました。

    [Endpoint Configuration (エンドポイント設定)] ウィンドウが表示されます。

  4. [Managing type (管理種別)]​ 項目で、​[Basic Endpoint (基本エンドポイント)]​ ラジオボタンを選択します。

  5. [Application type (アプリケーション種別)]​ 項目で、​[Non-Mule application (非 Mule アプリケーション)]​ ラジオボタンを選択します。

  6. 必要に応じて、​[Implementation URI (実装 URI)]​ を指定し、​[Save (保存)]​ をクリックします。

    API が作成されます。

Anypoint Service Mesh の Autocreate 機能を使用した API の作成

2022 年 10 月 29 日以降、API の Autocreate 機能に関するユーザーログイン情報オプションはサポートされなくなりました。接続アプリケーション方式に移行する必要があります。詳細は、次のセクションと​「Obtain Connected Apps credentials page (接続アプリケーションのログイン情報ページの取得)」​を参照してください。

Anypoint Service Mesh の Autocreate 機能を使用して API を作成する場合は、認証に​接続アプリケーションのログイン情報​を使用できます。このオプションは、次のユーザーに使用できます。

  • Anypoint Platform または外部 IdP によって管理されている

  • 多要素認証は有効にしていてもしていなくてもよい

接続アプリケーションのログイン情報を使用した API の自動作成

Anypoint Service Mesh の Autocreate 機能を設定する前に、以下を確認してください。

  • 以下を取得します。

  • クライアントのログイン情報に以下の権限を付与されていること:

    • API を Exchange にパブリッシュするための「Exchange Contributor (Exchange コントリビューター)」権限

    • API Manager で API を管理するための「Manage API Configuration (API 設定の管理)」権限

接続アプリケーションを使用して API を自動作成するには、次の手順を実行します。

  1. Anypoint Service Mesh を使用して、次のコマンドを入力して API を作成します。

    asmctl api create \
    --name=_Kubernetes API resource name_ \
    --namespace=_namespace name_ \
    --environmentId=_environment ID_ \
    --groupId=_(Optional) group ID of the asset, for example, organization ID_ \
    --assetId=_asset ID on Exchange_ \
    --version=_asset version of the instance on exchange_ \
    --instanceLabel=_label of the instance on API Manager_ \
    --specTags=_list of comma separated tags to be added to the asset on Exchange_ \
    --instanceTags=_list of comma separated tags to be added to the instance on API Manager_ \
    --clientId=_ID of the Anypoint Platform Connected Apps, using which to create the API instance_ \
    --clientSecret=_client secret of the Anypoint Platform Connected Apps, using which to create the API instance_
    パラメーター名 説明 必須または省略可能 デフォルト値

    name

    プロビジョニングする Kubernetes API リソースの名前 (例: orders-api​)

    必須

    適用なし

    namespace

    API を作成する名前空間 (例: mulesoft-apps​)

    必須

    適用なし

    environmentId

    API インスタンスを作成する環境の ID。

    必須

    適用なし

    groupId

    API Manager ランディングページまたは [Access Management (アセット管理)] から取得できる Exchange のアセットグループの ID (例: 組織 ID)

    省略可能

    環境が含まれる組織の組織 ID。

    assetId

    組織に含まれるアセットの ID (スペースを含まない英数文字)

    必須

    適用なし

    version

    メジャー、マイナー、およびパッチリリースのセマンティックバージョン設定の形式での Exchange のアセットのバージョン

    必須

    適用なし

    instanceLabel

    特定の環境内のアセットの API インスタンスの ID (スペースを含まない英数文字)

    必須

    適用なし

    classifier

    作成する API アセットの種別: http​、​oas​、または ​raml​。

    省略可能

    http

    mainFile

    ZIP ファイルのプライマリファイル名と一致する API 仕様ファイルのメインファイルの名前 (YAML または JSON ファイル名の要件に準拠)。

    http​ 以外のすべての分類子に対して指定

    適用なし

    specPath

    API 仕様ファイルへの相対または絶対パス。

    分類子が ​http​ 以外の場合は必須

    適用なし

    specTags

    Exchange のアセットに追加するタグ

    省略可能

    適用なし

    instanceTags

    API Manager の API インスタンスに追加するタグ

    省略可能

    適用なし

    clientId

    API の作成に使用する Anypoint Platform 接続アプリケーションのクライアント ID

    必須

    適用なし

    clientSecret

    API の作成に使用する Anypoint Platform 接続アプリケーションのクライアントシークレット

    必須

    適用なし

  2. API が正常に作成されていることを確認します。 ​asmctl api list

  3. 必要に応じて、Exchange アセットが Exchange で作成されていて API が API Manager で作成されていることを確認します。