Importera SAP OData-metadata som ett API

GÄLLER FÖR: Alla API Management-nivåer

Den här artikeln visar hur du importerar en OData-tjänst med hjälp av dess metadatabeskrivning. I den här artikeln fungerar SAP Gateway Foundation som ett exempel.

I den här artikeln ska du:

• Hämta OData-metadata från din SAP-tjänst
• Importera OData-metadata till API Management, antingen direkt eller efter konvertering till en OpenAPI-specifikation
• Fullständig API-konfiguration
• Testa API:et i Azure Portal

Kommentar

Import av ett OData-API till API Management från dess metadatabeskrivning är en förhandsversion. Läs mer.

Förutsättningar

• En befintlig API Management-instans. Skapa en om du inte redan har gjort det.

• Ett SAP-system och en tjänst som exponeras som OData v2 eller v4.

• Om SAP-serverdelen använder ett självsignerat certifikat (i testsyfte) kan du behöva inaktivera verifieringen av förtroendekedjan för SSL. Det gör du genom att konfigurera en serverdel i DIN API Management-instans:

  1. I Azure-portalen går du till API:er och väljer Serverdelar>+ Lägg till.
  2. Lägg till en anpassad URL som pekar på SAP-serverdelstjänsten.
  3. Avmarkera Verifiera certifikatkedjan och Verifiera certifikatnamnet.

  Kommentar

  För produktionsscenarier använder du rätt certifikat för SSL-verifiering från slutpunkt till slutpunkt.

Hämta OData-metadata från din SAP-tjänst

Hämta metadata-XML från DIN SAP-tjänst med någon av följande metoder. Om du planerar att konvertera metadata-XML till en OpenAPI-specifikation sparar du filen lokalt.

• Använd SAP Gateway-klienten (transaktion /IWFND/GW_CLIENT) eller
• Gör ett direkt HTTP-anrop för att hämta XML:en: http://<OData server URL>:<port>/<path>/$metadata

Gå till API Management-instansen

1. I Azure-portalen söker du efter och väljer API Management-tjänster.

   

2. På sidan API Management-tjänster väljer du din API Management-instans.

   

Importera API till API Management

Välj någon av följande metoder för att importera ditt API till API Management: importera metadata-XML som ett OData-API direkt eller konvertera metadata-XML till en OpenAPI-specifikation.

OData-metadata

Importera OData-metadata

1. I den vänstra menyn väljer du API:er>+ Lägg till API.

2. Under Skapa från definition väljer du OData.

   

3. Ange API-inställningar. Du kan uppdatera inställningarna senare genom att gå till fliken Inställningar i API:et.

   1. I OData-specifikation anger du en URL för en OData-metadataslutpunkt, vanligtvis URL:en till tjänstroten, som läggs till med /$metadata. Du kan också välja en lokal OData XML-fil som ska importeras.

   2. Ange återstående inställningar för att konfigurera ditt API. De här inställningarna beskrivs i självstudien Importera och publicera ditt första API .

4. Välj Skapa.

   API:et läggs till i LISTAN ÖVER API:er . Entitetsuppsättningar och funktioner som exponeras i beskrivningen av OData-metadata visas på fliken Entitetsuppsättningar och funktioner i API:et.

   

Uppdatera OData-schemat

Du kan komma åt en redigerare i portalen för att visa ditt API:s OData-schema. Om API:et ändras kan du även uppdatera schemat i API Management från en fil eller en OData-tjänstslutpunkt.

1. I portalen navigerar du till din API Management-instans.

2. I den vänstra menyn väljer du API:er> för ditt OData-API.

3. På fliken Entitetsuppsättningar och funktioner väljer du snabbmenyn (...) bredvid en entitetsuppsättning eller funktion och väljer Redigera.

   

4. Granska schemat. Om du vill uppdatera den väljer du Uppdatera från fil eller Uppdatera schema från slutpunkten.

   

Testa ditt OData-API

1. I den vänstra menyn väljer du API:er> för ditt OData-API.

2. På fliken Entitetsuppsättningar och funktioner väljer du snabbmenyn (...) bredvid en entitetsuppsättning eller funktion och väljer Testa.

   

3. I testkonsolen anger du mallparametrar, frågeparametrar och huvuden för testet och väljer Testa. Läs mer om att testa ett API i portalen.

Skydda ditt OData-API

Skydda ditt OData-API genom att använda både befintliga autentiserings- och auktoriseringsprinciper och en OData-valideringsprincip för att skydda mot attacker via OData API-begäranden.

Dricks

I portalen konfigurerar du principer för ditt OData-API på fliken API-principer .

OpenAPI-specifikation

Konvertera OData-metadata till OpenAPI JSON

1. Konvertera OData XML till OpenAPI JSON-format. Använd ett OASIS-verktyg med öppen källkod för OData v2 eller OData v4, beroende på din metadata-XML.

   Följande är ett exempelkommando för att konvertera OData v2 XML för testtjänsten 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
   

   Kommentar

   • I testsyfte med en enda XML-fil kan du använda en webbaserad konverterare baserat på verktyget med öppen källkod.
   • Med verktyget eller den webbaserade konverteraren är det valfritt att <ange IP-adressen>:<porten> för SAP OData-servern. Du kan också lägga till den här informationen senare i din genererade OpenAPI-specifikation eller efter import till API Management.

2. openapi-spec.json Spara filen lokalt för import till API Management.

Importera och publicera serverdels-API

1. I sidonavigeringsmenyn går du till avsnittet API:er och väljer API:er.

2. Under Skapa en ny definition väljer du OpenAPI-specifikation.

   

3. Klicka på Välj en fil och välj den openapi-spec.json fil som du sparade lokalt i ett tidigare steg.

4. Ange API-inställningar. Du kan ange värdena när du skapar eller konfigurera dem senare genom att gå till fliken Inställningar.

   • I API URL-suffixet rekommenderar vi att du använder samma URL-sökväg som i den ursprungliga SAP-tjänsten.

   • Mer information om API-inställningar finns i Importera och publicera din första API-självstudie .

5. Välj Skapa.

Kommentar

Begränsningarna för API-import dokumenteras i en annan artikel.

Fullständig API-konfiguration

Lägg till följande tre åtgärder i api:et som du importerade.

• GET /$metadata

  Operation	beskrivning	Ytterligare konfiguration för drift
  GET /$metadata	Gör att API Management kan nå $metadata slutpunkten, vilket krävs för klientintegrering med OData-servern. Den här nödvändiga åtgärden ingår inte i OpenAPI-specifikationen som du genererade och importerade.	Lägg till ett 200 OK svar.

  

• HEAD /

  Operation	beskrivning	Ytterligare konfiguration för drift
  HEAD /	Gör att klienten kan utbyta CSRF-token (Cross Site Request Forgery) med SAP-servern när det behövs. SAP tillåter även CSRF-tokenutbyte med hjälp av GET-verbet. CSRF-tokenutbyte beskrivs inte i den här artikeln. Se ett exempel på ETT API Management-principfragment för att förmedla tokenutbyte.	Ej tillämpligt

  

• GET /

  Operation	beskrivning	Ytterligare konfiguration för drift
  GET /	Aktiverar principkonfiguration i tjänstroten.	Konfigurera följande princip för inkommande omskrivning-uri för att lägga till ett avslutande snedstreck i begäranden som vidarebefordras till tjänstroten: <rewrite-uri template="/" copy-unmatched-params="true" /> Den här principen tar bort potentiell tvetydighet för begäranden med eller utan avslutande snedstreck, som behandlas på olika sätt av vissa serverdelar.

  

Konfigurera även autentisering till serverdelen med en lämplig metod för din miljö. Exempel finns i API Management-autentiserings- och auktoriseringsprinciper.

Testa ditt API

1. Gå till din API Management-instans.

2. I sidonavigeringsmenyn går du till avsnittet API:er och väljer API:er.

3. Under Alla API:er väljer du ditt importerade API.

4. Välj fliken Test för att komma åt testkonsolen.

5. Välj en åtgärd, ange nödvändiga värden och välj Skicka.

   Testa till exempel anropet GET /$metadata för att verifiera anslutningen till SAP-serverdelen

6. Visa svaret. Spåra samtalet för att felsöka.

7. När testningen är klar avslutar du testkonsolen.

Produktionsöverväganden

• Se ett exempel på ett scenario från slutpunkt till slutpunkt för att integrera API Management med en SAP-gateway.
• Kontrollera åtkomsten till en SAP-serverdel med hjälp av API Management-principer. Om API:et till exempel importeras som ett OData-API använder du principen verifiera OData-begäran . Se även principfragment för SAP-huvudspridning och hämtning av en X-CSRF-token.
• Vägledning för att distribuera, hantera och migrera API:er i stor skala finns i:
  • Automatiserade API-distributioner med APIOps
  • CI/CD för API Management med hjälp av Azure Resource Manager-mallar.

Närliggande information

• Begränsningar för API-import
• Importera en OpenAPI-specifikation
• Importera ett SOAP-API
• Importera ett SOAP-API och konvertera till REST
• Importera ett App Service-API
• Importera ett API för containerapp
• Importera ett WebSocket-API
• Importera ett GraphQL-API
• Importera ett GraphQL-schema och konfigurera fältmatchare
• Importera en Azure-funktionsapp
• Importera en Azure-logikapp
• Importera en Service Fabric-tjänst
• Importera ett OData-API
• Importera SAP OData-metadata
• Importera ett gRPC-API
• Redigera ett API