Importera en OpenAPI-specifikation

2025-04-05

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

Den här artikeln visar hur du importerar en "OpenAPI-specifikation" serverdels-API till Azure API Management med hjälp av olika verktyg. Artikeln visar också hur du testar API:et i API Management.

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

Importera en OpenAPI-specifikation med hjälp av Azure Portal, Azure CLI eller Azure PowerShell
Testa API:et i Azure Portal

Anteckning

BEGRÄNSNINGAR för API-import dokumenteras i API-importbegränsningar och kända problem.

Förutsättningar

En instans av API Management. Om du inte redan har en, slutför du följande snabbstart: Skapa en Azure API Management-instans.
Azure CLI (kommandoradsgränssnittet för Azure)
- Använd Bash-miljön i Azure Cloud Shell. Mer information finns i Kom igång med Azure Cloud Shell.
- Om du föredrar att köra CLI-referenskommandon lokalt installerar du Azure CLI. Om du kör i Windows eller macOS kan du köra Azure CLI i en Docker-container. Mer information finns i Så här kör du Azure CLI i en Docker-container.
  - Om du använder en lokal installation loggar du in på Azure CLI med hjälp av kommandot az login. Slutför autentiseringsprocessen genom att följa stegen som visas i terminalen. Andra inloggningsalternativ finns i Autentisera till Azure med Azure CLI.
  - När du uppmanas att installera Azure CLI-tillägget vid första användningen. Mer information om tillägg finns i Använda och hantera tillägg med Azure CLI.
  - Kör az version om du vill hitta versionen och de beroende bibliotek som är installerade. Om du vill uppgradera till den senaste versionen kör du az upgrade.
Azure PowerShell
- Om du väljer att använda Azure PowerShell lokalt:
  - Installera den senaste versionen av Az PowerShell-modulen.
  - Anslut till ditt Azure-konto med hjälp av cmdleten Connect-AzAccount .
- Om du väljer att använda Azure Cloud Shell:
  - Mer information finns i Översikt över Azure Cloud Shell .

Importera ett backend-API

I det här exemplet importerar du OpenAPI-specifikationen för öppen källkod Petstore API, men du kan ersätta en OpenAPI-specifikation som du väljer.

I Azure Portal navigerar du till din API Management-instans.
I den vänstra menyn väljer du API:er>+ Lägg till API.
Under Skapa från definition väljer du OpenAPI.
Ange API-inställningar. Du kan ange värdena när du skapar eller konfigurera dem senare genom att gå till fliken Inställningar . Inställningarna beskrivs i självstudien Importera och publicera ditt första API .
Välj Skapa.

I följande exempel används kommandot az apim api import för att importera en OpenAPI-specifikation från den angivna URL:en till en API Management-instans med namnet apim-hello-world. Om du vill importera med hjälp av en sökväg till en specifikation i stället för en URL använder du parametern --specification-path .

# API Management service-specific details
APIMServiceName="apim-hello-world"
ResourceGroupName="myResourceGroup"

# API-specific details
APIId="swagger-petstore"
APIPath="store"
SpecificationFormat="OpenAPI"
SpecificationURL="https://petstore3.swagger.io/api/v3/openapi.json"

# Import API
az apim api import --path $APIPath --resource-group $ResourceGroupName \
    --service-name $APIMServiceName --api-id $APIId \
    --specification-format $SpecificationFormat --specification-url $SpecificationURL

När du har importerat API:et kan du vid behov uppdatera inställningarna med hjälp av kommandot az apim api update .

I följande exempel används Azure PowerShell-cmdleten Import-AzApiManagementApi för att importera en OpenAPI-specifikation från den angivna URL:en till en API Management-instans med namnet apim-hello-world. Om du vill importera med hjälp av en sökväg till en specifikation i stället för en URL använder du parametern -SpecificationPath .

# API Management service-specific details
$apimServiceName = "apim-hello-world"
$resourceGroupName = "myResourceGroup"

# API-specific details
$apiId = "swagger-petstore"
$apiPath = "store"
$specificationFormat = "OpenAPI"
$specificationUrl = "https://petstore3.swagger.io/api/v3/openapi.json"

# Get context of the API Management instance. 
$context = New-AzApiManagementContext -ResourceGroupName $resourceGroupName -ServiceName $apimServiceName

# Import API
Import-AzApiManagementApi -Context $context -ApiId $apiId -SpecificationFormat $specificationFormat -SpecificationUrl $specificationUrl -Path $apiPath

När du har importerat API:et kan du vid behov uppdatera inställningarna med hjälp av cmdleten Set-AzApiManagementApi .

Visa och redigera OpenAPI-specifikation

I portalen använder du OpenAPI-specifikationsredigeraren för att visa, verifiera eller redigera specifikationen för det API som du importerade.

Så här använder du OpenAPI-specifikationsredigeraren:

I Azure Portal navigerar du till din API Management-instans.
I den vänstra menyn, under API:er, väljer du ><>
På fliken Design i Klientdelen väljer du OpenAPI Specification Editor (pennikon). Du kan öppna specifikationen i JSON- eller YAML-format.
Granska eller redigera specifikationen efter behov. Spara dina ändringar.

Verifiera mot ett OpenAPI-specifikationsschema

Du kan konfigurera API Management-valideringsprinciper för att verifiera begäranden och svar (eller element av dem) mot schemat i en OpenAPI-specifikation. Använd till exempel policyn för valideringsinnehåll för att verifiera storleken eller innehållet i en begäran eller svarstext.

Testa det nya API:et i portalen

Åtgärder kan anropas direkt från portalen, vilket är ett bekvämt sätt för administratörer att visa och testa åtgärderna i ett API.

Välj det API som du skapade i föregående steg.
Välj fliken Test.
Välj en åtgärd. Sidan visar fält för frågeparametrar och fält för sidhuvudena.

Anteckning

I testkonsolen fyller API Management automatiskt i huvud Ocp-Apim-Subscription-Key och konfigurerar prenumerationsnyckeln för den inbyggda prenumerationen 'All Access'. Den här nyckeln ger åtkomst till varje API i API Management-instansen. Du kan välja att visa Ocp-Apim-Subscription-Key-huvudet genom att välja "ögon"-ikonen bredvid HTTP-begäran.
Beroende på åtgärden anger du frågeparametervärden, rubrikvärden eller en begärandetext. Välj Skicka.

När testet lyckas svarar serverdelen med en lyckad HTTP-svarskod och vissa data.

Tips

Som standard skickar testkonsolen en begäran till API Managements CORS-proxy, som vidarebefordrar begäran till API Management-instansen, som sedan vidarebefordrar den till serverdelen. Den här proxyn använder den offentliga IP-adressen 13.91.254.72 och kan bara nå offentliga slutpunkter. Om du vill skicka en begäran direkt från webbläsaren till API Management-tjänsten väljer du Kringgå CORS-proxy. Använd det här alternativet när du vill använda testkonsolen och DIN API Management-gateway är nätverksisolerad eller inte tillåter trafik från CORS-proxyn.

Information om hur du felsöker ett API finns i Självstudie: Felsöka dina API:er med hjälp av spårning av begäranden.

Lägg till andra API:er

Du kan skapa ett API av 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-funktioner
Azure Logic Appar
Azure Service Fabric

Anteckning

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

Så här lägger du till ett API i ett befintligt API:

Gå till din Azure API Management-instans i Azure-portalen:
Välj API:er på sidan Översikt eller välj API:er>API:er på menyn till vänster.
Välj ellipsen (...) bredvid det API som du vill lägga till ett annat API till.
Välj Importera från den nedrullningsbara menyn:
Välj en tjänst som ett API ska importeras från.

Feedback

Var den här sidan till hjälp?