SAP OData-metagegevens importeren als 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. In dit artikel fungeert SAP Gateway Foundation als voorbeeld.

In dit artikel gaat u het volgende doen:

• OData-metagegevens ophalen uit uw SAP-service
• OData-metagegevens importeren in API Management, direct of na conversie naar een OpenAPI-specificatie
• Volledige API-configuratie
• De API testen in Azure Portal

Notitie

Het importeren van een OData-API naar API Management vanuit de metagegevensbeschrijving is in preview. Meer informatie.

Vereisten

• Een bestaand API Management-exemplaar. Maak er een als u dat nog niet hebt gedaan.

• 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 testdoeleinden), moet u mogelijk de verificatie van de vertrouwensketen voor SSL uitschakelen. Hiervoor configureert u een back-end in uw API Management-exemplaar:

  1. Selecteer in Azure Portal, onder API's, back-ends>+ toevoegen.
  2. Voeg een aangepaste URL toe die verwijst naar de SAP-back-endservice.
  3. Schakel Het selectievakje Certificaatketen valideren en certificaatnaam valideren uit.

  Notitie

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

OData-metagegevens ophalen uit uw SAP-service

Haal metagegevens-XML op uit uw SAP-service met behulp van een van de volgende methoden. Als u van plan bent om het XML-bestand met metagegevens te converteren naar een OpenAPI-specificatie, slaat u het bestand 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 uw API Management-exemplaar

1. Zoek en selecteer API Management-services in Azure Portal.

   

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

   

API importeren in API Management

Kies een van de volgende methoden om uw API te importeren in API Management: importeer de XML met metagegevens als een OData-API rechtstreeks of converteer de XML met metagegevens naar een OpenAPI-specificatie.

OData-metagegevens

OData-metagegevens importeren

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

2. Selecteer OData onder Maken op basis van definitie.

   

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

   1. Voer in de OData-specificatie een URL in voor een OData-metagegevenseindpunt, meestal de URL naar de hoofdmap van de service, waaraan wordt toegevoegd/$metadata. U kunt ook een lokaal OData XML-bestand selecteren dat u wilt importeren.

   2. Voer de resterende instellingen in om uw API te configureren. Deze instellingen worden uitgelegd in de zelfstudie Importeren en publiceren van uw eerste API .

4. Selecteer Maken.

   De API wordt toegevoegd aan de lijst met API's . De entiteitsets en functies die worden weergegeven in de beschrijving van de OData-metagegevens, worden weergegeven op het tabblad Entiteitensets en functies van de API.

   

Het OData-schema bijwerken

U hebt toegang tot een editor in de portal om het OData-schema van uw API weer te geven. Als de API wordt gewijzigd, kunt u het schema in API Management ook bijwerken vanuit een bestand of een OData-service-eindpunt.

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

2. Selecteer in het linkermenu API's> uw OData-API.

3. Selecteer op het tabblad Entiteitssets en functies het contextmenu (...) naast een entiteitsset of functie en selecteer Bewerken.

   

4. Controleer het schema. Als u deze wilt bijwerken, selecteert u Bijwerken uit bestand of Schema bijwerken vanaf eindpunt.

   

Uw OData-API testen

1. Selecteer in het linkermenu API's> uw OData-API.

2. Selecteer op het tabblad Entiteitssets en functies het contextmenu (...) naast een entiteitsset of functie en selecteer Testen.

   

3. Voer in de testconsole sjabloonparameters, queryparameters en headers voor uw test in en selecteer Testen. Meer informatie over het testen van een API in de portal.

Uw OData-API beveiligen

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

Tip

Configureer in de portal beleidsregels voor uw OData-API op het tabblad API-beleid .

OpenAPI-specificatie

OData-metagegevens converteren naar OpenAPI JSON

1. Converteer de OData XML naar de OpenAPI JSON-indeling. Gebruik een opensource-hulpprogramma voor OASIS voor OData v2 of OData v4, afhankelijk van uw XML-metagegevens.

   Hier volgt een voorbeeldopdracht voor het converteren van OData v2 XML 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
   

   Notitie

   • Voor testdoeleinden met één XML-bestand kunt u een webconversieprogramma gebruiken op basis van het opensource-hulpprogramma.
   • Met het hulpprogramma of het webconversieprogramma is het opgeven van het <IP-adres>:< poort> van uw SAP OData-server optioneel. U kunt deze informatie ook later toevoegen aan de gegenereerde OpenAPI-specificatie of na het importeren in API Management.

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

Back-end-API importeren en publiceren

1. Selecteer API's in het navigatiemenu aan de zijkant, onder de sectie API's.

2. Selecteer onder Een nieuwe definitie maken de OpenAPI-specificatie.

   

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

4. Voer API-instellingen in. U kunt de waarden instellen tijdens het maken of later configureren door naar het tabblad Instellingen te gaan.

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

   • Zie de eerste API-zelfstudie importeren en publiceren voor meer informatie over API-instellingen.

5. Selecteer Maken.

Notitie

De API-importbeperkingen staan in een ander artikel.

Volledige API-configuratie

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

• GET /$metadata

  Operation	Omschrijving	Verdere configuratie voor bewerking
  GET /$metadata	Hiermee kan API Management het $metadata eindpunt bereiken. Dit is vereist voor clientintegratie met de OData-server. Deze vereiste bewerking is niet opgenomen in de OpenAPI-specificatie die u hebt gegenereerd en geïmporteerd.	Voeg een 200 OK antwoord toe.

  

• HEAD /

  Operation	Omschrijving	Verdere configuratie voor bewerking
  HEAD /	Stelt de client in staat om CSRF-tokens (Cross Site Request Forgery) uit te wisselen met de SAP-server, indien nodig. MET SAP kan ook CSRF-token worden uitgewisseld met behulp van het GET-werkwoord. CSRF-tokenuitwisseling wordt niet behandeld in dit artikel. Zie een voorbeeld van een API Management-beleidsfragment voor het uitwisselen van brokertoken.	N.v.t.

  

• GET /

  Operation	Omschrijving	Verdere configuratie voor bewerking
  GET /	Hiermee schakelt u beleidsconfiguratie in de hoofdmap van de service in.	Configureer het volgende binnenkomende herschrijf-URI-beleid om een afsluitende slash toe te voegen aan aanvragen die worden doorgestuurd naar de hoofdmap van de service: <rewrite-uri template="/" copy-unmatched-params="true" /> Dit beleid verwijdert mogelijke dubbelzinnigheid van aanvragen met of zonder afsluitende slashes, die anders worden behandeld door sommige back-ends.

  

Configureer ook verificatie voor uw back-end met behulp van een geschikte methode voor uw omgeving. Zie API Management-verificatie- en autorisatiebeleid voor voorbeelden.

Uw API testen

1. Navigeer naar uw API Management-exemplaar.

2. Selecteer API's in het navigatiemenu aan de zijkant, onder 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 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 het testen is voltooid, sluit u de testconsole af.

Overwegingen voor productie

• Zie 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. Als de API bijvoorbeeld wordt geïmporteerd als een OData-API, gebruikt u het beleid voor OData-aanvragen valideren. Zie ook beleidsfragmenten voor het doorgeven van SAP-principals 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 onderwerpen

• Beperkingen bij het importeren van API's
• Een OpenAPI-specificatie importeren
• Een SOAP-API importeren
• Een SOAP-API importeren en deze converteren naar REST
• Een App Service-API importeren
• Een Container App-API importeren
• Een WebSocket-API importeren
• Een GraphQL-API importeren
• Een GraphQL-schema importeren en veldoplossers instellen
• Een Azure-functie-app importeren
• Een logische Azure-app importeren
• Een Service Fabric-service importeren
• Een OData-API importeren
• SAP OData-metagegevens importeren
• Een gRPC-API importeren
• Een API bewerken