1. Homepage
  2. Anypoint Code Builder
  3. API 仕様とフラグメントの設計

  4. Exchange への API プロジェクトのパブリッシュ

Exchange への API プロジェクトのパブリッシュ

進行中のベータリリース​: クラウド IDE は進行中のベータリリースです​。ベータ状態での Anypoint Code Builder の使用には、IDE で入手できる、該当するベータサービス契約条件が適用されます。

API プロジェクトを Anypoint Exchange にパブリッシュして、他のチームメンバーがそれらを見つけて使用できるようにします。

始める前に

API プロジェクトをパブリッシュする前に次の操作を実行します。

Exchange に API プロジェクトをパブリッシュする

Exchange に API プロジェクトをパブリッシュする手順は、次のとおりです。

  1. Anypoint Platform アカウントにログインします。

  2. [Explorer]​ で、API プロジェクトを開き、[Publish API Project to Exchange (Exchange に API プロジェクトをパブリッシュ)] アイコンをクリックします。

    [Publish API Project to Exchange (Exchange に API プロジェクトをパブリッシュ)] アイコン

    プロジェクトを開かない場合は、API 仕様を右クリックして ​[Publish API Project to Exchange (Exchange に API プロジェクトをパブリッシュ)]​ を選択することもできます。

    または、次の手順を実行します。

    1. コマンドパレットを開きます。

      手順を表示

      • キーボードショートカットを使用する。

        • Mac: Cmd+Shift+p

        • Windows: Ctrl+Shift+p

      • デスクトップ IDE で、​[View (表示)]​ > ​[Command Palette (コマンドパレット)]​ を選択する。

      • クラウド IDE で、​​ (メニュー) アイコンをクリックし、​[View (表示)]​ > ​[Command Palette (コマンドパレット)]​ を選択する。

    2. 「publish」​と入力し、次のコマンドを選択します。

      MuleSoft: Publish API Project to Exchange

  3. 確認を促されたら、​[Allow (許可)]​ をクリックし、プロンプトに従って Anypoint Platform にサインインします。

  4. [Publish API Project to Exchange (Exchange に API プロジェクトをパブリッシュ)]​ の各項目を確認または変更します。

    • Asset version (アセットバージョン)

    • API Version (API バージョン)

      API プロジェクトが Exchange に一度もパブリッシュされていない場合、デフォルトのバージョンは ​1.0.0​ になります。

      API フラグメントの場合、API バージョンは必要ありません。

    • Business Group (ビジネスグループ)

      API プロジェクトの作成時にビジネスグループを選択した場合、この項目はフォームに表示されません。​[Project Metadata (プロジェクトメタデータ)]​ を展開して、ビジネスを表示および更新できます。

  5. 必要に応じて、​[Project Metadata (プロジェクトメタデータ)]​ を展開し、​[API Project Properties (API プロジェクトプロパティ)]​ をクリックして、アセット名と ID の更新、タグとカテゴリの追加、ビジネスグループの更新など、API プロジェクトのメタデータの更新を行います。詳細は、​「API プロジェクトにメタデータを追加する」​を参照してください。

    1. 更新が完了したら、​[Apply (適用)]​ をクリックします。

  6. バナーで ​[Sync centralized governance rulesets and run validation (中央管理ガバナンスルールセットを同期して検証を実行)]​ をクリックし、適用されたルールセットに API プロジェクトが準拠していることを確認します。

    このステップは省略可能ですが、ベストプラクティスとして推奨されます。ルールセットを検証するには、Anypoint Platform アカウントにログインし、API プロジェクトメタデータでビジネスグループを定義している必要があります。

    中央管理ルールセットを同期するためのバナーがある [Publish API Project to Exchange (Exchange に API プロジェクトをパブリッシュ)] フォーム

  7. [Publish (パブリッシュ)]​ をクリックします。

    パブリッシュが完了したら、API 仕様が Exchange に正常にパブリッシュされたことを示すメッセージが表示されます。

    API プロジェクトにエラーがある場合は、Exchange にパブリッシュする前にエラーを修正する必要があります。エラーは ​[Problems (問題)]​ タブに表示されます。[Publish API Project to Exchange (Exchange に API プロジェクトをパブリッシュ)] アイコンをクリックして、​[Problems (問題)]​ タブにフォーカスを移動します。

  8. Exchange でパブリッシュされたアセットを表示するには、​[View Asset (アセットを表示)]​ をクリックします。

  9. API を実装するように促されたら、次のいずれかを選択します。

    • インテグレーションに API 仕様をスキャフォールディングしないようにするには、​[No (いいえ)]​ を選択します。

    • 新しいプロジェクトに API 仕様をスキャフォールディングするには、​[Yes (はい)]​ を選択します。

      手順を表示

      1. 表示された項目に実装プロジェクトの名前を入力します。

      2. プロジェクトのディレクトリに移動し、​[Select target folder (対象フォルダーを選択)]​ をクリックします。

      3. プロジェクトの Mule Runtime (Mule) バージョンを選択します。

      4. Mule でサポートされる Java バージョンを選択します。

      5. スキャフォールディングプロセスが完了したら、[Explorer] で ​src/main/mule​ ディレクトリからプロジェクトのスキャフォールディング済みインターフェースを表示します。

        スキャフォールディングが失敗する場合は、実装エラーを参照してください。

        [Explorer] から新しいプロジェクトの ​mule-artifact.json​ ファイルを開いて、Mule バージョンと Java バージョンを確認することもできます。次に例を示します。

        {
    "minMuleVersion": "4.6.2",
    "javaSpecificationVersions": [
        "11"
    ]
}

        mule-artifact.json​ ファイルはプロジェクトディレクトリのルートレベルにあります。

Exchange で API を見つける

API 仕様をパブリッシュしたら、Anypoint Exchange でその API 仕様を見つけることができます。

  1. Anypoint Platform に移動し、ログイン情報を使用してログインします。

    手順を表示

  2. Anypoint Exchange に移動します。

    手順を表示

    API 仕様が組織のアセットとして表示されます。次に例を示します。

    Exchange 内の API 仕様

API を選択し、その概要に移動して、前のタスクで定義したすべてのエンドポイントを表示できます。Exchange のアセットの詳細ページにドキュメントがない REST API のドキュメントを生成することもできます。詳細は、 「Einstein 生成 AI を使用した API ドキュメントの生成」​を参照してください。

Exchange に GraphQL API 仕様をパブリッシュする

GraphQL API 仕様を Exchange にパブリッシュする手順は、次のとおりです。

  1. Anypoint Platform に移動し、ログイン情報を使用してログインします。

    手順を表示

  2. Anypoint Exchange に移動します。

    手順を表示

  3. [Publish new asset (新規アセットをパブリッシュ)]​ をクリックします。

    Exchange の [Publish new asset (新規アセットをパブリッシュ)] ボタン

  4. [Publish a new asset (新規アセットをパブリッシュ)]​ フォームに情報を入力します。

    Exchange の [Publish a new asset (新規アセットをパブリッシュ)] フォーム

    1. [Name (名前)]​ にアセットの名前を入力します。

    2. [Asset types (アセットタイプ)]​ では、​[GraphQL API]​ を選択します。

    3. [Method (方法)]​ では、​[Upload a GraphQL API Schema (GraphQL API スキーマをアップロード)]​ を選択します。

    4. [File upload (ファイルアップロード)]​ では、​[Choose file (ファイルを選択)]​ をクリックして目的の ​.graphql​ スキーマファイルを探します。

    5. バージョン番号を変更するには、​[Advanced (詳細)]​ をクリックします。

    6. [Lifecycle state (ライフサイクル状態)]​ では、​[Stable (安定)]​ を選択します。

  5. [Publish (パブリッシュ)]​ をクリックします。

次の例のように、GraphQL API 仕様が Exchange で利用できるようになりました。

Exchange での GraphQL API 仕様

関連情報