Import metadat SAP OData jako rozhraní API

PLATÍ PRO: Všechny úrovně služby správy rozhraní API

Tento článek popisuje, jak importovat službu OData pomocí popisu metadat. Jako příklad se používá sap Gateway Foundation.

V tomto článku:

• Načtení metadat OData ze služby SAP
• Import metadat OData do služby Azure 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

• Instance správy API. Pokud ho nemáte, proveďte kroky v tématu Vytvoření instance služby API Management pomocí webu Azure Portal.

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

• Pokud váš back-end SAP používá certifikát podepsaný svým držitelem (k 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 portálu Azure, v části Rozhraní API, vyberte Backends>+ Přidat.
  2. Přidejte vlastní adresu URL , která odkazuje na back-endovou službu SAP.
  3. Zrušte zaškrtnutí políček 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

K načtení XML metadat ze služby SAP použijte jednu z následujících metod. Pokud plánujete převést XML metadat na specifikaci OpenAPI, uložte soubor místně.

• Použijte 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 portálu Azure 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 přímo jako rozhraní API OData.
• Převeďte XML metadat na specifikaci OpenAPI.

Metadata systému OData

Import metadat OData

1. V nabídce vlevo vyberte rozhraní API> a pak vyberte + 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. Tato hodnota je obvykle adresa URL kořenového adresáře služby, připojena pomocí /$metadata. Případně vyberte místní soubor XML OData, který chcete importovat.

   2. Zadejte další nastavení pro konfiguraci rozhraní API. Tato nastavení jsou vysvětlena v tutoriálu Import a publikování vašeho prvního 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

V portálu můžete přistoupit k editoru a zobrazit si 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 a pak vyberte rozhraní API OData.

3. Na kartě Sady entit a funkce vyberte tři tečky (...) vedle sady nebo funkce entity a pak 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 a pak vyberte rozhraní API OData.

2. Na kartě Sady entit a funkce vyberte tři tečky (...) vedle sady nebo funkce entity a pak vyberte Test.

   

3. V testovací konzole zadejte parametry šablony, parametry dotazu a hlavičky testu a pak vyberte Test. Další informace o testování rozhraní API na portálu najdete v tématu Testování nového 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 azásad ověřování OData pro ochranu před útoky prostřednictvím požadavků rozhraní OData API.

Návod

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ásledující příklad převede OData v2 XML 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:

   • K 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 souboru do služby API Management.

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

Import specifikace OpenAPI

1. V levém navigačním podokně v části Rozhraní API vyberte rozhraní API.

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

   

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

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

   • Pro příponu adresy URL rozhraní API doporučujeme použít stejnou cestu URL jako u původní služby 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:

Informace o omezeních importu rozhraní API najdete v tématu Omezení importu rozhraní API a známé problémy.

Dokončení konfigurace rozhraní API

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

• GET /$metadata

  Operace	Popis	Další konfigurace operace
  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 /

  Operace	Popis
  HEAD /	Umožňuje klientovi vyměňovat tokeny CSRF (cross-site request forgery) se serverem SAP, pokud je to nutné. SAP také umožňuje výměnu tokenů CSRF prostřednictvím příkazu GET. Výměna tokenů CSRF není popsána v tomto článku. Podívejte se na příklad výňatku zásady služby API Management pro zprostředkování výměny tokenů.

  

• GET /

  Operace	Popis	Další konfigurace operace
  GET /	Povolí konfiguraci zásad v kořenovém adresáři služby.	Nakonfigurujte následující zásadu rewrite-uri pro připojení koncového lomítka k žádostem, které jsou předávány službě v servisním kořenovém adresáři: <rewrite-uri template="/" copy-unmatched-params="true" /> Tato politika odstraňuje potenciální nejednoznačnost mezi požadavky s a bez koncových lomítek. Některé back-endy zachází s těmito dvěma typy požadavků odlišně.

  

Také je potřeba nakonfigurovat ověřování na back-end 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 levém navigačním podokně 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 pak vyberte Odeslat.

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

6. Zobrazte odpověď. K odstranění problémů sledujte hovor.

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

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

• Podívejte se na ukázkový kompletní scénář 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. Existují také fragmenty zásad pro šíření objektu zabezpečení SAP pro SAP ECC nebo S/4HANA nebo SAP SuccessFactors 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.

Související obsah

• Omezení importu rozhraní API
• Importovat specifikaci OpenAPI
• Importujte API SOAP
• Import rozhraní SOAP API a jeho převod na rozhraní REST
• Importujte rozhraní API služby App Service
• Importujte API aplikace kontejneru
• Importujte API WebSocket
• Importujte GraphQL API
• Import schématu GraphQL a nastavení překladačů polí
• Importujte rozhraní API funkční aplikace
• Import rozhraní API aplikace logiky
• Importovat službu Service Fabric
• Importujte API Azure AI Foundry rozhraní
• Importujte rozhraní API Azure OpenAI
• Import rozhraní LLM API
• Import OData API
• Exportujte REST API jako MCP server
• Zveřejnění existujícího serveru MCP
• Import rozhraní API agenta A2A
• Import metadata SAP OData
• Importujte rozhraní API gRPC
• Úprava rozhraní API