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

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

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

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

   

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

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

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

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

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

   

OData スキーマを更新する

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

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

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

3. [Entity sets and functions] タブ上で、エンティティ セットまたは関数の横にあるコンテキスト メニュー ([...]) を選択し、[Edit] を選択します。

   

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

   

OData API をテストする

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

2. [Entity sets and functions] タブ上で、エンティティ セットまたは関数の横にあるコンテキスト メニュー ([...]) を選択し、[Test] を選択します。

   

3. テスト コンソール内で、テスト用の [Template parameters]、[Query parameters]、[Headers] を入力し、[Test] を選択します。 ポータル内での 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 をテスト サービス epm_ref_apps_prod_man_srv 用に変換するコマンドの例を示します。

   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
   

   注意

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

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

バックエンド API のインポートと発行

1. サイド ナビゲーション メニューの [API] セクションで、 [API] を選択します。

2. [Create a new definition](新しい定義の作成) で、[OpenAPI の仕様] を選択します。

   

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

4. API 設定を入力します。 値は、作成時に設定することも、後で [設定] タブに移動して構成することもできます。

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

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

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

API の構成を完了する

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

• GET /$metadata

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

  

• HEAD /

  操作	説明	操作の詳細な構成
  HEAD /	必要に応じて、クライアントがクロスサイト リクエスト フォージェリ (CSRF) トークンを SAP サーバーと交換できるようにします。 SAP では、Get Verb を使用して CSRF トークンの交換を行うこともできます。 CSRF トークンの交換については、この記事では説明しません。 トークンの交換を仲介する API Management ポリシー スニペットの例を参照してください。	該当なし

  

• GET /

  操作	説明	操作の詳細な構成
  GET /	サービス ルートでのポリシーの構成を有効にします。	次の受信 rewrite-uri ポリシーを構成し、サービス ルートに転送される要求に末尾のスラッシュを追加します。 <rewrite-uri template="/" copy-unmatched-params="true" /> このポリシーでは、末尾のスラッシュがある場合とない場合に、一部のバックエンドで異なる方法で処理されるために要求があいまいになる可能性を排除します。

  

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

API のテスト

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

2. サイド ナビゲーション メニューの [API] セクションで、 [API] を選択します。

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

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

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

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

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

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