Dela via


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

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.

    Välj API Management-tjänster

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

    Välj 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.

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.

    Skärmbild av att skapa ett API från en OData-beskrivning i portalen.

  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.

    Skärmbild av OData-entitetsuppsättningar och funktioner i portalen.

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.

    Skärmbild av snabbmenyn för en OData-entitet som angetts i portalen.

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

    Skärmbild av schemaredigeraren för OData API i portalen.

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.

    Skärmbild av alternativet Testa på snabbmenyn för en OData-entitet som angetts i portalen.

  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 .

Produktionsöverväganden