SAP OData メタデータを API としてインポートする

OData メタデータをインポートする

1. 左側のメニューで、APIAPI を選択し、[ + API の追加] を選択します。

2. [ 定義から作成] で、 OData を選択します。

   ポータルで OData の説明から API を作成しているスクリーンショット。

3. API 設定を入力します。 API の [設定] タブに移動することで、後で設定を更新することができます。

   1. OData 仕様で、OData メタデータ エンドポイントの URL を入力します。 通常、この値はサービス ルートの URL であり、 が追加されます。 または、インポートするローカルの OData XML ファイルを選択します。

   2. API を構成するための追加の設定を入力します。 設定については、「最初の API のインポートと発行」のチュートリアルで説明されています。

4. ［作成］ を選択します

   API が API の一覧に追加されます。 OData メタデータ説明の中で公開されているエンティティ セットと関数が、API の [Entity sets and functions] タブ上に表示されます。

   OData エンティティ セットと関数を示すスクリーンショット。

OData スキーマを更新する

ポータルでエディターにアクセスして、API の OData スキーマを表示できます。 API が変更された場合は、ファイルまたは OData サービス エンドポイントから API Management のスキーマを更新することもできます。

1. portal で、API Management インスタンスに移動します。

2. 左側のメニューで [ API] を選択し、OData API を選択します。

3. [ エンティティ セットと関数 ] タブで、エンティティ セットまたは関数の横にある省略記号 (...) を選択し、[ 編集] を選択します。

   [編集] コマンドの場所を示すスクリーンショット。

4. スキーマを確認します。 更新する場合は、[ファイルから更新する] または [エンドポイントからスキーマを更新する] を選択します。

   OData API のスキーマ エディターのスクリーンショット。

OData API をテストする

1. 左側のメニューで [ API] を選択し、OData API を選択します。

2. [ エンティティ セットと関数 ] タブで、エンティティ セットまたは関数の横にある省略記号 (...) を選択し、[ テスト] を選択します。

   [テスト] コマンドを示すスクリーンショット。

3. テスト コンソールで、テストのテンプレート パラメーター、クエリ パラメーター、ヘッダーを入力し、[ テスト] を選択します。 ポータルでの API のテストの詳細については、ポータルでの 新しい API のテストを参照してください。

OData API をセキュリティで保護する

OData API 要求を通じて攻撃から保護するために、既存の 認証と承認ポリシー と OData 検証ポリシー を適用して、OData API をセキュリティで保護します。

OData メタデータを OpenAPI JSON に変換する

1. OData XML を OpenAPI JSON 形式に変換します。 メタデータ XML に応じて、OData v2 または OData v4 用の OASIS オープンソース ツールを使用します。

   次の例では、テスト サービスの OData v2 XML を 変換します。

   odata-openapi -p --basePath '/sap/opu/odata/sap/epm_ref_apps_prod_man_srv' \
    --scheme https --host <your IP address>:<your SSL port> \
    ./epm_ref_apps_prod_man_srv.xml
   

   注

   • 1 つの XML ファイルを使用してテストする場合は、オープンソース ツールに基づく Web ベースのコンバーター を使用できます。
   • ツールまたは Web ベースのコンバーターを使用して、SAP OData サーバーの IP アドレス : ポート を指定できます (省略可能)。 または、生成された OpenAPI 仕様の後で、またはファイルを API Management にインポートした後に、この情報を追加します。

2. API Management にインポートするために、 ファイルをローカルに保存します。

OpenAPI 仕様のインポート

1. 左側のナビゲーション ウィンドウの [API ] セクションで、API を選択 します。

2. [ 新しい定義の作成] で、 OpenAPI を選択します。

   OpenAPI タイルを示すスクリーンショット。

3. [ ファイルの選択] をクリックし、前の手順でローカルに保存した ファイルを選択します。

4. API 設定を入力します。 これらの値は、API をインポートするときに設定することも、後で [設定] タブに移動して構成することもできます。

   • API URL サフィックスの場合は、元の SAP サービスと同じ URL パスを使用することをお勧めします。

   • API 設定の詳細については、「最初の API のインポートと発行」のチュートリアルを参照してください。

5. ［作成］ を選択します

API 構成を完了する

インポートした API に次の 3 つの操作を追加します。

• GET /$metadata

  操作	説明	操作の追加構成
  GET /$metadata	API Management が エンドポイントに到達できるようにします。これは、OData サーバーとクライアントを統合するために必要です。 この必須の操作は、生成してインポートした OpenAPI 仕様に含まれていません。	応答を追加します。

  GET メタデータ操作を示すスクリーンショット。

• HEAD /

  操作	説明
  HEAD /	必要に応じて、クライアントがクロスサイト リクエスト フォージェリ (CSRF) トークンを SAP サーバーと交換できるようにします。 SAP では、GET 動詞を介した CSRF トークン交換も許可されます。 CSRF トークンの交換については、この記事では説明しません。 ブローカー トークン交換に関する example API Management ポリシー スニペットを参照してください。

  トークンをフェッチする操作を示すスクリーンショット。

• GET /

  操作	説明	操作の追加構成
  GET /	サービス ルートでポリシー構成を有効にします。	サービス ルートに転送される要求に末尾のスラッシュを追加するには、次の受信 書き換え URI ポリシーを構成します。 <rewrite-uri template="/" copy-unmatched-params="true" /> このポリシーは、末尾のスラッシュの有無によって発生する可能性のあるあいまいさを解消します。 これら 2 種類の要求は、一部のバックエンドによって異なる方法で処理されます。

  サービス ルートの GET 操作を示すスクリーンショット。

また、環境に適した方法を使用して、バックエンドへの認証を構成する必要もあります。 例については、API Management の認証および認可ポリシーを参照してください。

API のテスト

1. API Management インスタンスに移動します。

2. 左側のナビゲーション ウィンドウの [API ] セクションで、API を選択 します。

3. [すべての API] で、インポートした API を選択します。

4. [テスト] タブを選択して、テスト コンソールにアクセスします。

5. 操作を選択し、必要な値を入力して、[ 送信] を選択します。

   たとえば、 呼び出しをテストして、SAP バックエンドへの接続を確認します。

6. 応答を表示します。 トラブルシューティングを行うには、呼び出しをトレースします。

7. テストが完了したら、テスト コンソールを終了します。