1. Homepage
  2. Anypoint Code Builder

  3. Exchange への API 仕様とフラグメントのパブリッシュ

Exchange への API 仕様とフラグメントのパブリッシュ

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

API 仕様またはフラグメントを Anypoint Exchange にパブリッシュして、他のチームメンバーがそれらを見つけて使用できるようにします。

始める前に

API 仕様またはフラグメントをパブリッシュする前に次の操作を実行します。

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

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

  1. Anypoint Code Builder で API 仕様を開きます。

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

    手順を表示

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

      • Mac: Cmd+Shift+p

      • Windows: Ctrl+Shift+p

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

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

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

    MuleSoft: Publish API Specification to Exchange
    コマンドパレット内で強調表示されている MuleSoft: Publish API Specification to Exchange

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

  5. [Select a Business Group (ビジネスグループを選択)]​ で、プロジェクトのビジネスグループを見つけて選択します。

    詳細は、​始める前に​を参照してください。

  6. [Set Project Name (プロジェクト名を設定)]​ で、プロジェクト名を確認または入力して、Enter キーを押します。

  7. 各項目を確認または変更して、Enter キーを押します。

    • Artifact ID (アーティファクト ID) (​OAS-Example​ など)。

    • Asset version (アセットバージョン) (​1.0.0​ など)。

    • API version (API バージョン) (​v1​ など)。

    パブリッシュをキャンセルするには、Escape キーを押します。

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

    強調表示された、Exchange への API 仕様のパブリッシュの通知

  8. 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 に 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 仕様