1. Homepage
  2. DataGraph

  3. 統合スキーマへの API ソースの追加

統合スキーマへの API ソースの追加

API を追加すると、Anypoint DataGraph によってその API の仕様から API スキーマが生成されます。そのスキーマを統合スキーマに追加する前に編集できます。

API 仕様の要素には API スキーマに追加されないものがあります (GET 以外の操作など)。詳細は、​「API スキーマ生成時に発生する可能性があるエラー」​を参照してください。

API を統合スキーマに追加するには、次の 3 つのタスクを実行します。

  1. API を Anypoint DataGraph に追加する​

  2. 生成された API スキーマをプレビューする​

  3. API スキーマを編集し、競合があれば解決する​

    生成された API スキーマを統合スキーマに追加する前に、オブジェクト種別間の競合を解決する必要があります。詳細は、​「競合の解決と不整合のマージ」​を参照してください。

API を追加すると、次のことができるようになります。

Anypoint CLI​ を使用して DataGraph で API ソースを追加および編集することもできます。ただし、CLI を使用して API ソースを追加する場合は、UI で直接編集したりそのバージョンを更新したりすることはできません。これらの変更は CLI を使用して行う必要があります。

始める前に

API を統合スキーマに追加するには、次のことを確認します。

  • RAML または OAS のいずれかの仕様を使用する REST API を作成した。

  • 統合スキーマと同じ組織の Exchange に API をパブリッシュした。DataGraph でサポートされるのは、​安定​状態の API バージョンのみです。

  • アクセス可能な URL を使用して API のインスタンスを開始した。

API は Mule アプリケーションでなくても、Mule Runtime Engine または CloudHub 上で実行されていなくてもかまいません。

さらに、次のことを確認する必要があります。

  • API を追加するための​適切な権限​がある。

  • Anypoint DataGraph を使用するビジネスグループまたは組織に、プランの指定どおりに適切な数の vCore が割り当てられている。API を追加しようとしている環境に適切な数の vCore が割り当てられていない場合、Anypoint DataGraph からエラーメッセージが表示されます。

API を Anypoint DataGraph に追加する

API を統合スキーマに追加するための最初のタスクでは、アセットバージョン、URL、認証方法を設定して API を Anypoint DataGraph に追加します。

  • Anypoint DataGraph から API にアクセスするためにサポートされている認証方法は次の手順に記載されています。それ以外の認証方法 (有効期間の短いトークン方式など) はサポートされていません。詳細は、​「サポートされる認証方法」​を参照してください。

  1. [Anypoint Platform] > [Anypoint DataGraph] で ​[Unified Data Graph (統合データグラフ)]​ ドロップダウンリストから適切な環境を選択し、​[+Add API (+API を追加)]​ をクリックします。

  2. [Select API (API を選択)]​ ページで、追加する API を選択します。

  3. [Next: Configure URL (次へ: URL を設定)]​ をクリックします。

  4. [Configure URL (URL を設定)]​ ページで、追加する API の API バージョンとアセットバージョンを選択し、​[Confirm Selection (選択を確認)]​ を選択します。

  5. 引き続き ​[Configure URL (URL を設定)]​ ページで、API の URL を次のように追加または編集します。

    • API が API Manager で管理されているか、Exchange の API のインスタンスを追加した場合は、​[Get an existing URL from Anypoint Platform (Anypoint Platform から既存の URL を取得)]​ を選択します。

    • 独自の実装 URL を手動で指定する場合は、​[Add a new URL (新しい URL を追加)]​ を選択します。

  6. [Next: Provide authentication (次へ: 認証を指定)]​ をクリックします。

  7. [Configure Security (セキュリティを設定)]​ ページで、追加する API の GET エンドポイントの認証種別を選択します。

    • No Auth (認証なし)​: API が公開の場合に使用します。

    • Basic Auth (基本認証)​: ユーザ名とパスワードを使用して API に対する認証を行う場合に使用します。

    • Pass-through (パススルー)​: 認証ヘッダーを渡して API に対する認証を行う場合に使用します。

    • Client ID enforcement via headers (ヘッダー経由のクライアント ID 適用)​: client_id​ および ​client_secret​ ヘッダーを渡して API に対する認証を行う場合に使用します。

    • Client ID enforcement via query parameters (クエリパラメータ経由のクライアント ID 適用)​: client_id​ および ​client_secret​ クエリパラメータを渡して API に対する認証を行う場合に使用します。

    • OAuth 2.0 Client Credentials (OAuth 2.0 クライアントログイン情報)​: OAuth 2.0 の ​client_id​、​client_secret​、認証サーバの値を渡して API に対する認証を行う場合に使用します。

    • Custom (カスタム)​: カスタムヘッダーパラメータと値を使用して API に対する認証を行う場合に使用します。

  8. 引き続き ​[Configure Security (セキュリティを設定)]​ ページで、必要に応じてキーストアを追加して API と DataGraph 間の相互認証 (mTLS) を設定します。

    [Configure Keystore (キーストアを設定)]​ を選択して次の情報を指定します。

    • 組織の「ルート」認証機関 (CA) によって署名された公開証明書

    • 証明書署名要求 (CSR) の生成に使用される非公開キー

    • 非公開キーのパスワード

  9. 必要に応じて、トラストストアを追加して統合スキーマから API へのアクセスを許可します。

    [Configure Truststore (トラストストアを設定)]​ を選択して、ルート CA が含まれる証明書バンドルを指定します。

  10. [Next: Preview Schema (次へ: スキーマをプレビュー)]​ をクリックします。

生成された API スキーマをプレビューする

API の追加後、Anypoint DataGraph によって自動的に API の仕様が対応する API スキーマに変換されます。そのスキーマをプレビューしてから、編集し、競合があれば解決します。

  1. [Preview Schema (スキーマをプレビュー)]​ ページで、API スキーマの種別と項目を確認します。

  2. スキーマのプレビューが完了したら、​[Next: Edit Schema (次へ: スキーマを編集)]​ をクリックします。

スキーマを編集して統合スキーマに追加する

API 追加の最期のタスクでは、​スキーマを編集​して競合があれば解決し、スキーマを強化します。

  1. Anypoint DataGraph でエラーが表示され、競合の解決を促されたら、​[Edit Schema (スキーマを編集)]​ ページで解決します。

    Anypoint DataGraph で表示された競合のプロンプトには推奨解決策が含まれます。

  2. 統合スキーマをより強固にするには、API スキーマを (この時点で、または統合スキーマに追加した後に) 編集して次の操作を実行します。

    • オブジェクト種別のコラボレーションを有効にする。

      該当する種別の​コラボレーションを有効に​して、必須の設定を指定します。これは省略可能ですが、種別のコラボレーションを有効にすると、作成する統合スキーマの接続や強化が促進されます。

    • スキーマ要素の表示を管理する。

      統合スキーマに表示したくない​項目、種別、クエリメソッドを非表示にする​ことができます。

    • スキーマ要素の名前を確認して編集する。

      統合スキーマに追加する​すべての項目、種別、クエリメソッドの名前を編集​してクエリへの関連性を高めることができます。

    • 類似のオブジェクト種別をマージする。

      種別をマージ​すると、類似の種別を統合して項目とデータセットを拡張し、クエリ結果をより強化できます。

    • オブジェクト種別間で関連項目をリンクする。

      リンク​すると、2 つの項目の関連項目を結合し、リンクした種別を照会するときにより広範囲の結果を返すことができます。

  3. [Next: Add to unified schema (次へ: 統合スキーマに追加)]​ をクリックします。

Anypoint DataGraph によって​統合スキーマが更新​されます。統合スキーマの更新時、スキーマの新しい変更を表示し、追加の変更を加え、新しい変更を適用できます。ただし、これらの変更は更新が完了するまで照会できません。更新には数分かかる場合があります。

スキーマに追加した API の URL を編集する

統合スキーマに追加した API の URL を編集する必要がある場合、​[API details (API の詳細)]​ ページで編集できます。

  1. [List of APIs added (追加された API のリスト)]​ をクリックし、URL を編集する API を選択します。

  2. [API details (API の詳細)]​ をクリックします。

  3. [API url (API の URL)]​ 項目の横にある ​[Edit URL (URL を編集)]​ をクリックします。

  4. 新しい URL を入力します。

  5. [Save (保存)]​ をクリックします。

統合スキーマに追加された API の認証方法を変更する

統合スキーマに追加した API の認証方法を編集する必要がある場合、​[API details (API の詳細)]​ ページで編集できます。現在の認証方法を削除して新しい認証方法を追加する必要があります。

認証方法を編集する手順は、次のとおりです。

  1. [List of APIs added (追加された API のリスト)]​ をクリックし、該当する API を選択します。

  2. [API details (API の詳細)]​ をクリックします。

  3. [Authentication (認証)]​ パネルで ​[remove and add a new one (削除して新規追加)]​ をクリックします。

  4. 認証ポリシーを選択し、必須項目に入力します。

  5. [Save (保存)]​ をクリックします。

統合スキーマに追加した API の mTLS を編集する

統合スキーマに追加した API の mTLS を設定する必要がある場合、​[API details (API の詳細)]​ ページでキーストアを追加して設定できます。

トラストストアを追加して統合スキーマから API へのアクセスを許可することもできます。

API にすでにキーストアまたはトラストストアがある場合、​[API details (API の詳細)]​ ページで削除してから新規追加できます。そのためには、​[Remove and add a new one (削除して新規追加)]​ をクリックします。

  1. [List of APIs added (追加された API のリスト)]​ をクリックし、URL を編集する API を選択します。

  2. [API details (API の詳細)]​ をクリックします。

  3. [Configure Keystore (キーストアを設定)]​ を選択して次の情報を指定します。

    • 組織の「ルート」認証機関 (CA) によって署名された公開証明書

    • 証明書署名要求 (CSR) の生成に使用される非公開キー

    • 非公開キーのパスワード

  4. 必要に応じて、​[Configure Truststore (トラストストアを設定)]​ を選択し、ルート CA が含まれる証明書バンドルへのリンクを指定します。

  5. [Save (保存)]​ をクリックします。

API バージョンを更新する

API スキーマを DataGraph に追加したら、いつでも API ソースのバージョンを更新できます。DataGraph でサポートされるのは、​安定​状態の API バージョンのみです。更新機能によって更新されるのは、API ソースのパッチおよびマイナーバージョンのみです。

CLI を使用して API ソースを追加する場合は、UI で直接そのバージョンを更新することはできません。これらの変更は CLI を使用して行う必要があります。

API の新しいバージョンを選択すると、新しいバージョンに自動的に適用できない現在のバージョンへの編集が DataGraph にリストされます。

DataGraph で自動的に適用できない編集には、更新を完了する前にそれらの編集を手動で適用するオプションがあります。

  1. [List of APIs added (追加された API のリスト)]​ をクリックし、該当する API を選択します。

  2. [API details (API の詳細)]​ をクリックします。

  3. [Updated Version (更新バージョン)]​ リストから、新しい API バージョンを選択します。

  4. [Next (次へ)]​ をクリックします。

  5. DataGraph で適用できない変更が検出された場合、​[Existing Edits Not Applied in Updated Schema (更新スキーマに適用されない既存の編集)]​ のリストを確認し、手動で適用します。

    1. カスタマイズを選択し、​[Next (次へ)]​ をクリックします。

    2. 必要に応じて API スキーマを編集し、​[Apply Changes (変更を適用)]​ をクリックします。

      変更を適用したら、追加の変更に対してステップ 5 を繰り返します。

  6. [Next (次へ)]​ をクリックして、新しいバージョンのスキーマを編集します。

関連リソース