Import metadat SAP OData jako rozhraní API

PLATÍ PRO: Všechny úrovně služby API Management

Tento článek ukazuje, jak importovat službu OData pomocí popisu metadat. V tomto článku slouží jako příklad základy SAP Gateway .

V tomto článku:

• Načtení metadat OData ze služby SAP
• Import metadat OData do služby API Management, a to buď přímo, nebo po převodu na specifikaci OpenAPI
• Dokončení konfigurace rozhraní API
• Testovat rozhraní API na portálu Azure Portal

Požadavky

• Existující instance služby API Management. Vytvořte ho, pokud jste to ještě neudělali.

• Systém a služba SAP vystavené jako OData v2 nebo v4.

• Pokud váš back-end SAP používá certifikát podepsaný svým držitelem (pro účely testování), možná budete muset zakázat ověření řetězce důvěryhodnosti pro SSL. Provedete to tak, že nakonfigurujete back-end ve vaší instanci služby API Management:

  1. Na webu Azure Portal v části Rozhraní API vyberte Back-endy>+ Přidat.
  2. Přidejte vlastní adresu URL odkazující na back-endovou službu SAP.
  3. Zrušte zaškrtnutí políčka Ověřit řetěz certifikátů a Ověřit název certifikátu.

  Poznámka:

  V produkčních scénářích používejte pro kompletní ověřování SSL správné certifikáty.

Načtení metadat OData ze služby SAP

Pomocí jedné z následujících metod načtěte z vaší služby SAP metadata XML. Pokud plánujete převést XML metadat na specifikaci OpenAPI, uložte soubor místně.

• Použití klienta sap Gateway (transakce /IWFND/GW_CLIENT) nebo
• Proveďte přímé volání HTTP pro načtení XML: http://<OData server URL>:<port>/<path>/$metadata

Přejít k instanci služby API Management

1. Na webu Azure Portal vyhledejte a vyberte služby API Management.

   

2. Na stránce služby API Management vyberte instanci služby API Management.

   

Import rozhraní API do služby API Management

Zvolte jednu z následujících metod pro import rozhraní API do služby API Management: importujte xml metadat jako rozhraní API OData přímo nebo převeďte xml metadata na specifikaci OpenAPI.

Metadata OData

Import metadat OData

1. V nabídce vlevo vyberte rozhraní API> + Přidat rozhraní API.

2. V části Vytvořit z definice vyberte OData.

   

3. Zadejte nastavení rozhraní API. Později můžete nastavení aktualizovat tak, že přejdete na kartu Nastavení rozhraní API.

   1. Ve specifikaci OData zadejte adresu URL koncového bodu metadat OData, obvykle adresu URL kořenového adresáře služby, která je připojena ./$metadata Případně vyberte místní soubor XML OData, který chcete importovat.

   2. Zadejte zbývající nastavení pro konfiguraci rozhraní API. Tato nastavení jsou vysvětlená v kurzu importu a publikování vašeho prvního kurzu rozhraní API .

4. Vyberte Vytvořit.

   Rozhraní API se přidá do seznamu rozhraní API . Sady entit a funkce, které jsou zveřejněné v popisu metadat OData, se zobrazí na kartě Sady entit a funkce rozhraní API.

   

Aktualizace schématu OData

K editoru na portálu se dostanete a zobrazí se schéma OData vašeho rozhraní API. Pokud se rozhraní API změní, můžete schéma ve službě API Management aktualizovat také ze souboru nebo koncového bodu služby OData.

1. Na portálu přejděte do vaší instance služby API Management.

2. V nabídce vlevo vyberte rozhraní API> vašeho rozhraní OData API.

3. Na kartě Sady entit a funkce vyberte místní nabídku (...) vedle sady nebo funkce entity a vyberte Upravit.

   

4. Zkontrolujte schéma. Pokud ho chcete aktualizovat, vyberte Možnost Aktualizovat ze souboru nebo Aktualizovat schéma z koncového bodu.

   

Testování rozhraní API OData

1. V nabídce vlevo vyberte rozhraní API> vašeho rozhraní OData API.

2. Na kartě Sady entit a funkce vyberte místní nabídku (...) vedle sady entit nebo funkce a vyberte Test.

   

3. V testovací konzole zadejte parametry šablony, parametry dotazu a hlavičky testu a vyberte Test. Přečtěte si další informace o testování rozhraní API na portálu.

Zabezpečení rozhraní OData API

Zabezpečte své rozhraní API OData použitím stávajících zásad ověřování a autorizace a zásad ověřování OData, které chrání před útoky prostřednictvím požadavků rozhraní OData API.

Tip

Na portálu nakonfigurujte zásady pro vaše rozhraní API OData na kartě Zásady rozhraní API.

Specifikace OpenAPI

Převod metadat OData na json OpenAPI

1. Převeďte formát OData XML na formát OPENAPI JSON. V závislosti na xml metadat použijte opensourcový nástroj OASIS pro OData v2 nebo OData v4.

   Následuje příklad příkazu pro převod XML OData v2 pro testovací službu 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
   

   Poznámka:

   • Pro účely testování s jedním souborem XML můžete použít webový převaděč založený na opensourcovém nástroji.
   • Pomocí nástroje nebo webového převaděče je zadání <IP adresy>:<portu> serveru SAP OData volitelné. Případně tyto informace přidejte později do vygenerované specifikace OpenAPI nebo po importu do služby API Management.

2. openapi-spec.json Uložte soubor místně pro import do služby API Management.

Import a publikování rozhraní API back-endu

1. V boční navigační nabídce v části Rozhraní API vyberte rozhraní API.

2. V části Vytvořit novou definici vyberte specifikaci OpenAPI.

   

3. Klikněte na Vybrat soubor a vyberte openapi-spec.json soubor, který jste uložili místně v předchozím kroku.

4. Zadejte nastavení rozhraní API. Hodnoty můžete nastavit při vytváření nebo je později nakonfigurovat tak, že přejdete na kartu Nastavení .

   • V příponě ADRESY URL rozhraní API doporučujeme použít stejnou cestu URL jako v původní službě SAP.

   • Další informace o nastavení rozhraní API najdete v tématu Import a publikování prvního kurzu rozhraní API .

5. Vyberte Vytvořit.

Poznámka:

Omezení importu rozhraní API jsou zdokumentovaná v jiném článku.

Dokončení konfigurace rozhraní API

Do rozhraní API, které jste naimportovali, přidejte následující tři operace.

• GET /$metadata

  Operation	Popis	Další konfigurace pro provoz
  GET /$metadata	Umožňuje službě API Management dosáhnout koncového $metadata bodu, který je nutný pro integraci klienta se serverem OData. Tato požadovaná operace není součástí specifikace OpenAPI, kterou jste vygenerovali a importovali.	200 OK Přidejte odpověď.

  

• HEAD /

  Operation	Popis	Další konfigurace pro provoz
  HEAD /	Umožňuje klientovi v případě potřeby vyměnit tokeny CSRF (Cross Site Request Forgery) se serverem SAP. SAP také umožňuje výměnu tokenů CSRF pomocí příkazu GET. Výměna tokenů CSRF není popsána v tomto článku. Podívejte se na příklad fragmentu zásad služby API Management pro výměnu tokenů zprostředkovatele.	–

  

• GET /

  Operation	Popis	Další konfigurace pro provoz
  GET /	Povolí konfiguraci zásad v kořenovém adresáři služby.	Nakonfigurujte následující zásadu přepisu příchozího přepisu-URI pro připojení koncového lomítka k žádostem předávaným do kořenového adresáře služby: <rewrite-uri template="/" copy-unmatched-params="true" /> Tato zásada odebere potenciální nejednoznačnost požadavků s koncovými lomítky nebo bez nich, které jsou zpracovávány různými back-endy.

  

Nakonfigurujte také ověřování back-endu pomocí vhodné metody pro vaše prostředí. Příklady najdete v tématu Ověřování a zásady autorizace služby API Management.

Testování rozhraní API

1. Přejděte do vaší instance služby API Management.

2. V boční navigační nabídce v části Rozhraní API vyberte rozhraní API.

3. V části Všechna rozhraní API vyberte importované rozhraní API.

4. Vyberte kartu Test pro přístup k testovací konzole.

5. Vyberte operaci, zadejte požadované hodnoty a vyberte Odeslat.

   Otestujte GET /$metadata například volání a ověřte připojení k back-endu SAP.

6. Zobrazte odpověď. Pokud chcete problém vyřešit, sledujte volání.

7. Po dokončení testování ukončete testovací konzolu.

Důležité informace o produkčním prostředí

• Podívejte se na příklad kompletního scénáře integrace služby API Management s bránou SAP.
• Řízení přístupu k back-endu SAP pomocí zásad služby API Management Pokud je například rozhraní API importováno jako rozhraní API OData, použijte zásadu ověření požadavku OData. Viz také fragmenty zásad pro šíření objektu zabezpečení SAP a načtení tokenu X-CSRF.
• Pokyny k nasazení, správě a migraci rozhraní API ve velkém měřítku najdete v tématech:
  • Automatizovaná nasazení rozhraní API s využitím APIOps
  • CI/CD pro API Management pomocí šablon Azure Resource Manageru.

Příbuzná témata

• Omezení importu rozhraní API
• Import specifikace OpenAPI
• Import rozhraní API protokolu SOAP
• Import rozhraní API protokolu SOAP a převod na REST
• Import rozhraní API služby App Service
• Import rozhraní API kontejnerové aplikace
• Import rozhraní WEBSocket API
• Import rozhraní GraphQL API
• Import schématu GraphQL a nastavení překladačů polí
• Import aplikace Azure Function App
• Import aplikace logiky Azure
• Import služby Service Fabric
• Import rozhraní API Azure OpenAI
• Import rozhraní OData API
• Import metadat SAP OData
• Import rozhraní API gRPC
• Úprava rozhraní API