Importera ett OData-API

  • Artikel

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

Den här artikeln visar hur du importerar en OData-kompatibel tjänst som ett API i API Management.

I den här artikeln kan du se hur du:

  • Importera en beskrivning av OData-metadata med hjälp av Azure-portalen
  • Hantera OData-schemat i portalen
  • Skydda OData-API:et

Kommentar

Import av en OData-tjänst som ett API från dess metadatabeskrivning är en förhandsversion.

Förutsättningar

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 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 .

Lägg till andra API:er

Du kan skapa ett API för API:er som exponeras av olika tjänster, inklusive:

  • En OpenAPI-specifikation
  • ETT SOAP-API
  • Ett GraphQL-API
  • En webbapp som finns i Azure App Service
  • Azure-funktionsapp
  • Azure Logic Program-program
  • Azure Service Fabric

Lägg till ett annat API i ditt befintliga API med hjälp av följande steg.

Kommentar

När du importerar ett annat API läggs åtgärderna i ditt aktuella API.

  1. Gå till din Azure API Management-instans i Azure-portalen.

    Gå till Azure API Mgmt-instans

  2. Välj API:er på sidan Översikt eller på menyn till vänster.

    Välj API:er

  3. Klicka på ... intill det API som du vill lägga till ett annat API till.

  4. Välj Import från den nedrullningsbara menyn.

    Välj Importera

  5. Välj en tjänst som ett API ska importeras från.

    Välj tjänst