1. Homepage
  2. Anypoint Code Builder
  3. American Flights アプリケーションの開発

  4. American Flights API 仕様の設計

American Flights API 仕様の設計

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

Anypoint Code Builder を使用して、American Flights API という名前の API 仕様の例を作成します。この API では、Anypoint Exchange から取得した API フラグメントを再利用し、データ型と応答の例を作成し、API Console を使用して API をテストし、API をアセットとして Exchange にパブリッシュします。

すべての API 仕様タスクを完了したら、​インテグレーション​内で仕様を​実装​します。詳細は、「American Flights アプリケーションの開発」を参照してください。

始める前に

  • Web またはデスクトップ IDE をセットアップしてアクセスします。

    詳細は、Anypoint Code Builder 入門を参照してください。

  • ビジネスグループ​に精通します。

    API 仕様はビジネスグループに属します。

American Flights API を開始する

American Flights API 仕様の作成を開始する手順は、次のとおりです。

  1. IDE のアクティビティバーで、​​ (​Anypoint Code Builder​) アイコンをクリックします。

    VS Code アクティビティバーの MuleSoft アイコン

  2. [Quick Actions (クイックアクション)]​ から ​[Design an API (API を設計)]​ をクリックします。

    MuleSoft パネルの [Design an API (API を設計)] へのリンク

    エラー ​[Mule DX API Component was not installed (Mule DX API コンポーネントがインストールされていません)]​ を受け取ったら、Mule Runtime が読み込まれてバックグラウンドプロセスが完了するまで待機します。バックグラウンドプロセスを監視するには、プロジェクト読み込みエラーを参照してください。

  3. 次の値を使用して API 仕様プロジェクトを設定します。

    項目名 Field Value (項目値)

    Project Name (プロジェクト名)

    American Flights API​
    または、任意の同様の名前を指定します。名前は一意である必要があります。プロジェクトと仕様ファイルの名前は、指定した名前に基づきます。

    Project Location (プロジェクトの場所)

    ホームディレクトリまたは作成する別のディレクトリ (ホームディレクトリへのフォルダーの追加を参照)。

    API Specification Language (API 仕様言語)

    RAML 1.0​
    Anypoint Code Builder では OAS と RAML がサポートされます。

  4. [Create Project (プロジェクトを作成)]​ を選択して、American Flights API プロジェクトファイル (​american-flights-api.raml​) を作成します。

    このファイル名は、プロジェクトに指定した名前に基づきます。

    American Airlines API のプロジェクト

  5. RAML リソースとメソッドを追加する​に進みます。

RAML リソースとメソッドを追加する

American Flights API で仕様の設定を開始して、その ​GET​ メソッドを API Console から試行します。

  1. 設定を開始する前に ​Mule DX Server​ への ​[Output (出力)]​ パネルを開いて、内部プロセスの進行状況を追跡します。

    パネルを開く手順は、次のとおりです。

    1. Cmd+Shift+u (Mac) または Ctrl+Shift+u (Windows) を押して [Output (出力)] パネルを開きます。

    2. パネルのドロップダウンメニューから ​[Mule DX Server]​ を選択します。

      詳細は、出力パネルを開くを参照してください。

  2. american-flights-api.raml​ で、​/flights​ エンドポイントと ​get​ メソッドの次の RAML コードをファイルに貼り付けます。

    #%RAML 1.0
title: American Flights API

/flights:
  get:

  3. get​ の直下の次の行で Ctrl+Space を押して、使用可能なすべてのオプションを表示し、​post​ メソッドを選択します。

    #%RAML 1.0
title: American Flights API

/flights:
  get:
  post:

  4. API Console アイコンをクリックして、コンソールに仕様を表示します。

    get および post メソッドが含まれている仕様

    1. API Console が読み込まれている間、​[Output (出力)]​ パネルで ​Mule DX Server​ を監視します。

    2. エディターで仕様ファイルをクリックして、API Console に仕様ファイルのエンドポイントを表示します。

    3. API Console にエンドポイントアイコンが表示されるまで待機します。

      API Console でのエンドポイントとメソッド:

      [API Console] 内で強調表示されている GET および POST メソッド

  5. クエリパラメーターとネストされたリソースを追加する​に進みます。

クエリパラメーターとネストされたリソースを追加する

目的地に基づいてフライトを取得するために使用するネストされたリソース (​/{ID}:​) を追加し、目的地の省略可能なクエリパラメーター (​queryParameters:​) を ​enum​ 値のセットとして指定します。

  1. RAML コンテンツを次の仕様で置き換えます。

    #%RAML 1.0
title: American Flights API

/flights:
  get:
    queryParameters:
      destination:
        required: false
        enum:
          - SFO
          - LAX
          - CLE
  post:

  /{ID}:
    get:

  2. ネストされたリソースを API Console に表示します。

    ネストされたリソースが含まれる API Console

  3. API 仕様へのサンプルの追加に進みます。