Importera SAP OData-metadata som ett API

Importera OData-metadata

1. Välj API:er> i den vänstra menyn och välj sedan + 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. Det här värdet är 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 ytterligare 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 och sedan ditt OData-API.

3. På fliken Entitetsuppsättningar och funktioner väljer du ellipsen (...) bredvid en entitetsuppsättning eller funktion och väljer sedan 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 och sedan ditt OData-API.

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

   

3. I testkonsolen anger du mallparametrar, frågeparametrar och huvuden för testet och väljer sedan Testa. Mer information om hur du testar API:er i portalen finns i Testa det nya API:et i portalen.

Skydda ditt OData-API

Skydda ditt OData-API genom att tillämpa befintliga autentiserings- och auktoriseringsprinciper och en OData-valideringsprincip för att skydda mot attacker via OData API-begäranden.

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.

   I följande exempel konverteras 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

   • För testning med en enda XML-fil kan du använda en webbaserad konverterare som baseras på ett verktyg 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 att du har importerat filen till API Management.

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

Importera OpenAPI-specifikation

1. I det vänstra navigeringsfönstret går du till avsnittet API:er och väljer API:er.

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

   

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

4. Ange API-inställningar. Du kan ange dessa värden när du importerar API:et eller konfigurerar dem senare genom att gå till fliken Inställningar .

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

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

5. Välj Skapa.

Slutför API-konfigurationen

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

• GET /$metadata

  Verksamhet	beskrivning	Ytterligare konfiguration för åtgärden
  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 /

  Verksamhet	beskrivning
  HEAD /	Gör det möjligt för klienten att vid behov utbyta CSRF-token (cross-site request forgery) med SAP-servern. SAP tillåter även CSRF-tokenutbyte via 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.

  

• GET /

  Verksamhet	beskrivning	Ytterligare konfiguration för åtgärden
  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 mellan begäranden med och utan avslutande snedstreck. Dessa två typer av begäranden behandlas på olika sätt av vissa serverdelar.

  

Du måste också konfigurera autentisering till serverdelen med hjälp av 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 det vänstra navigeringsfönstret 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 sedan Skicka.

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

6. Visa svaret. För att felsöka, spåra samtalet.

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