Importeer SAP OData-metadata als een API

Van toepassing op: Alle API Management-lagen

In dit artikel wordt beschreven hoe u een OData-service importeert met behulp van de beschrijving van de metagegevens. SAP Gateway Foundation wordt als voorbeeld gebruikt.

In dit artikel gaat u als volgt te werk:

• Haal OData-metadata op van uw SAP-service
• OData-metagegevens importeren in Azure API Management, rechtstreeks of na het converteren naar een OpenAPI-specificatie
• Voltooi API-configuratie
• Test de API in het Azure portal

Vereiste voorwaarden

• Een API Management-exemplaar. Als u nog geen exemplaar hebt, voert u de stappen in Een API Management-exemplaar maken uit met behulp van Azure Portal.

• Een SAP-systeem en -service die beschikbaar worden gesteld als OData v2 of v4.

• Als uw SAP-back-end gebruikmaakt van een zelfondertekend certificaat (voor testen), moet u mogelijk de verificatie van de vertrouwensketen voor SSL uitschakelen. Om dit te doen, configureer een backend in uw API Management-instantie.

  1. In de Azure-portal, onder API's, selecteer Backends>+ Toevoegen.
  2. Voeg een aangepaste URL toe die verwijst naar de SAP-back-endservice.
  3. Schakel de selectievakjes Certificaatketen valideren en Certificaatnaam valideren uit.

  Opmerking

  Gebruik in productiescenario's de juiste certificaten voor end-to-end SSL-verificatie.

Haal OData-metadata op van uw SAP-service

Gebruik een van de volgende methoden om XML-metagegevens op te halen uit uw SAP-service. Als u van plan bent de metadata XML naar een OpenAPI-specificatie om te zetten, sla het bestand dan lokaal op.

• Gebruik de SAP Gateway-client (transactie /IWFND/GW_CLIENT).
  of
• Maak een directe HTTP-aanroep om de XML op te halen: http://<OData server URL>:<port>/<path>/$metadata.

Ga naar je API Management-instantie

1. Zoek en selecteer in de Azure portalde API Management-services:

   

2. Selecteer op de pagina API Management-services uw API Management-exemplaar:

   

Een API importeren in API Management

Kies een van de volgende methoden om uw API te importeren in API Management:

• Importeer het XML-bestand met metagegevens rechtstreeks als een OData-API.
• Converteer het XML-bestand met metagegevens naar een OpenAPI-specificatie.

OData-metagegevens

OData-metagegevens importeren

1. Selecteer API's in> het linkermenu en selecteer vervolgens + API toevoegen.

2. Selecteer OData onder Maken op grond van definitie:

   

3. Voer de API-instellingen in. Je kunt je instellingen later bijwerken door naar het Instellingen tabblad van de API te gaan.

   1. Voer in OData-specificatie een URL in voor een OData-metagegevenseindpunt. Deze waarde is meestal de URL van de hoofdmap van de service, aangevuld met /$metadata. Als alternatief kunt u een lokaal OData XML-bestand selecteren om te importeren.

   2. Voer aanvullende instellingen in om uw API te configureren. Deze instellingen worden uitgelegd in de Importeer en publiceer je eerste API tutorial.

4. Klik op Creëren.

   De API wordt toegevoegd aan de lijst met API's. De entity sets en functies die worden blootgesteld in de OData-metadata beschrijving verschijnen op de Entity sets and functions-tab van de API.

   

Werk het OData-schema bij

U kunt toegang krijgen tot een editor in het portaal om het OData-schema van uw API te bekijken. Als de API verandert, kunt u ook het schema bijwerken in API Management vanuit een bestand of een OData-service eindpunt.

1. Navigeer in de portal naar je API Management-exemplaar.

2. Selecteer API's in het linkermenu en selecteer vervolgens uw OData-API.

3. Selecteer op het tabblad Entiteitsets en functies het beletselteken (...) naast een entiteitsset of functie en selecteer vervolgens Bewerken.

   

4. Bekijk het schema. Als u het wilt bijwerken, selecteer dan Bijwerken vanuit bestand of Schema bijwerken vanaf eindpunt.

   

Test uw OData API

1. Selecteer API's in het linkermenu en selecteer vervolgens uw OData-API.

2. Selecteer op het tabblad Entiteitsets en functies het beletselteken (...) naast een entiteitsset of functie en selecteer vervolgens Testen.

   

3. Voer in de testconsole sjabloonparameters, queryparameters en headers voor uw test in en selecteer vervolgens Testen. Zie De nieuwe API testen in de portal voor meer informatie over het testen van API's in de portal.

Beveilig uw OData API

Beveilig uw OData-API door bestaand verificatie- en autorisatiebeleid en een OData-validatiebeleid toe te passen om te beschermen tegen aanvallen via OData-API-aanvragen.

Aanbeveling

Stel in het portaal beleidsregels in voor uw OData-API op het tabblad API-beleidsregels.

OpenAPI-specificatie

OData-metagegevens converteren naar OpenAPI JSON

1. Converteer de OData XML naar de OpenAPI JSON-indeling. Gebruik een OASIS open-source tool voor OData v2 of OData v4, afhankelijk van uw metadata XML.

   In het volgende voorbeeld wordt OData v2 XML geconverteerd voor de testservice 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
   

   Opmerking

   • Voor het testen met één XML-bestand kunt u een webconversieprogramma gebruiken dat is gebaseerd op een opensource-hulpprogramma.
   • Met de tool of de webgebaseerde converter is het specificeren van het <IP-adres>:<poort> van uw SAP OData-server optioneel. U kunt deze informatie ook later toevoegen aan de gegenereerde OpenAPI-specificatie of nadat u het bestand in API Management hebt geïmporteerd.

2. Sla het openapi-spec.json-bestand lokaal op voor import in API Management.

OpenAPI-specificatie importeren

1. Selecteer API's in het linkernavigatiedeelvenster in de sectie API's.

2. Selecteer OpenAPI onder Een nieuwe definitie maken:

   

3. Klik op Een bestand selecteren en selecteer vervolgens het openapi-spec.json bestand dat u lokaal in een vorige stap hebt opgeslagen.

4. Voer de API-instellingen in. U kunt deze waarden instellen wanneer u de API importeert of deze later configureert door naar het tabblad Instellingen te gaan.

   • Voor het ACHTERvoegsel van de API-URL raden we u aan hetzelfde URL-pad te gebruiken als dat van de oorspronkelijke SAP-service.

   • Voor meer informatie over API-instellingen, zie de Importeer en publiceer uw eerste API-tutorial.

5. Klik op Creëren.

Opmerking

Zie API-importbeperkingen en bekende problemen voor informatie over api-importbeperkingen.

De API-configuratie voltooien

Voeg de volgende drie bewerkingen toe aan de API die u hebt geïmporteerd:

• GET /$metadata

  Operatie	Beschrijving	Aanvullende configuratie voor de bewerking
  GET /$metadata	Stelt API-beheer in staat om het $metadata-eindpunt te bereiken, wat nodig is voor clientintegratie met de OData-server. Deze vereiste operatie is niet opgenomen in de OpenAPI-specificatie die u heeft gegenereerd en geïmporteerd.	Voeg een 200 OK reactie toe.

  

• HEAD /

  Operatie	Beschrijving
  HEAD /	Hiermee kan de client aanvraagvervalsingstokens (CSRF) uitwisselen met de SAP-server wanneer dat nodig is. MET SAP kan ook CSRF-token worden uitgewisseld via het GET-werkwoord. Het uitwisselen van CSRF-tokens wordt niet behandeld in dit artikel. Zie een voorbeeld van een API Management-beleidsfragment voor het uitwisselen van brokertoken.

  

• GET /

  Operatie	Beschrijving	Aanvullende configuratie voor de bewerking
  GET /	Stelt u in staat beleidsconfiguratie in de rootdirectory van de service te configureren.	Configureer het volgende inkomende rewrite-uri-beleid om een afsluitende slash toe te voegen aan aanvragen die worden doorgestuurd naar de basis van de service: <rewrite-uri template="/" copy-unmatched-params="true" /> Dit beleid verwijdert mogelijke dubbelzinnigheid tussen aanvragen met en zonder slashes achteraan. Deze twee typen aanvragen worden verschillend behandeld door sommige back-ends.

  

U moet ook verificatie voor uw back-end configureren met behulp van een geschikte methode voor uw omgeving. Voor voorbeelden, zie API Management authenticatie- en autorisatiebeleidsregels.

Uw API testen

1. Navigeer naar uw API Management-exemplaar.

2. Selecteer API's in het linkernavigatiedeelvenster in de sectie API's.

3. Selecteer uw geïmporteerde API onder Alle API's.

4. Selecteer het tabblad Testen om toegang te krijgen tot de testconsole.

5. Selecteer een bewerking, voer de vereiste waarden in en selecteer vervolgens Verzenden.

   Test bijvoorbeeld de aanroep om de GET /$metadata verbinding met de SAP-back-end te controleren.

6. Bekijk het antwoord. Als u problemen wilt oplossen, moet u de aanroep traceren .

7. Wanneer u klaar bent met testen, sluit u de testconsole af.

Overwegingen voor productie

• Bekijk een voorbeeld van een end-to-end scenario voor het integreren van API Management met een SAP-gateway.
• Toegang tot een SAP-back-end beheren met behulp van API Management-beleid. Gebruik bijvoorbeeld de valideer OData-verzoek beleidslijn als de API als een OData API is geïmporteerd. Er zijn ook beleidsfragmenten voor het doorgeven van SAP-principals voor SAP ECC of S/4HANA of SAP SuccessFactors en het ophalen van een X-CSRF-token.
• Zie voor hulp bij het implementeren, beheren en migreren van API's op schaal:
  • Geautomatiseerde API-implementaties met APIOps.
  • CI/CD voor API Management met behulp van Azure Resource Manager-sjablonen.

Verwante inhoud

• API import beperkingen
• Importeer een OpenAPI-specificatie
• Een SOAP-API importeren
• Een SOAP-API importeren en deze naar REST converteren
• Importeer een App Service API
• Een API voor een container-app importeren
• Een WebSocket-API importeren
• Een GraphQL-API importeren
• Importeer een GraphQL-schema en stel veldresolvers in
• Een api voor een functie-app importeren
• Een API voor een logische app importeren
• Importeer een Service Fabric-service
• Een Azure AI Foundry-API importeren
• Een Azure OpenAI-API importeren
• Een LLM-API importeren
• Een OData-API importeren
• Importeer SAP OData metadata
• Een gRPC-API importeren
• Een API bewerken