Import specifikace OpenAPI

PLATÍ PRO: Všechny úrovně služby API Management

Tento článek ukazuje, jak importovat back-endové rozhraní API "specifikace OpenAPI" umístěné na https://conferenceapi.azurewebsites.net?format=jsonadrese . Toto back-endové rozhraní API poskytuje Microsoft a hostuje ho na Azure. Tento článek také ukazuje, jak otestovat rozhraní API služby APIM.

V tomto článku získáte informace o těchto tématech:

• Import specifikace OpenAPI pomocí webu Azure Portal, Azure CLI nebo Azure PowerShellu
• Testovat rozhraní API na portálu Azure Portal

Poznámka:

Omezení importu rozhraní API jsou zdokumentovaná v omezeních importu rozhraní API a známých problémech.

Požadavky

• Instance služby API Management. Pokud ho ještě nemáte, proveďte následující rychlý start: Vytvořte instanci služby Azure API Management.

• Azure CLI

  • Použijte prostředí Bash v Azure Cloud Shellu. Další informace najdete v tématu Rychlý start pro Bash v Azure Cloud Shellu.

    

  • Pokud dáváte přednost místnímu spouštění referenčních příkazů rozhraní příkazového řádku, nainstalujte Azure CLI. Pokud používáte Windows nebo macOS, zvažte spuštění Azure CLI v kontejneru Docker. Další informace najdete v tématu Jak spustit Azure CLI v kontejneru Dockeru.

    • Pokud používáte místní instalaci, přihlaste se k Azure CLI pomocí příkazu az login. Pokud chcete dokončit proces ověřování, postupujte podle kroků zobrazených na terminálu. Další možnosti přihlášení najdete v tématu Přihlášení pomocí Azure CLI.

    • Po zobrazení výzvy nainstalujte rozšíření Azure CLI při prvním použití. Další informace o rozšířeních najdete v tématu Využití rozšíření v Azure CLI.

    • Spuštěním příkazu az version zjistěte verzi a závislé knihovny, které jsou nainstalované. Pokud chcete upgradovat na nejnovější verzi, spusťte az upgrade.

• Azure PowerShell

  • Pokud se rozhodnete používat Azure PowerShell místně:
    • Nainstalujte nejnovější verzi modulu Az PowerShell.
    • Připojení k účtu Azure pomocí rutiny Připojení-AzAccount.
  • Pokud se rozhodnete použít Azure Cloud Shell:
    • Další informace najdete v přehledu služby Azure Cloud Shell .

Import rozhraní API back-endu

Azure Portal

1. Na webu Azure Portal přejděte k vaší instanci služby API Management.

2. V nabídce vlevo vyberte rozhraní API> + Přidat rozhraní API.

3. V části Vytvořit z definice vyberte OpenAPI.

   

4. Zadejte nastavení rozhraní API. Hodnoty můžete nastavit při vytváření nebo je později nakonfigurovat tak, že přejdete na kartu Nastavení. Nastavení jsou vysvětlená v kurzu Import a publikování vašeho prvního kurzu rozhraní API.

5. Vyberte Vytvořit.

Azure CLI

Následující příklad používá příkaz az apim api import k importu specifikace OpenAPI ze zadané adresy URL do instance služby API Management s názvem apim-hello-world. Pokud chcete místo adresy URL importovat cestu ke specifikaci, použijte parametr --specification-path .

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

# API-specific details
APIId="demo-conference-api"
APIPath="conference"
SpecificationFormat="OpenAPI"
SpecificationURL="https://conferenceapi.azurewebsites.net/?format=json"

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

Po importu rozhraní API v případě potřeby můžete nastavení aktualizovat pomocí příkazu az apim api update .

PowerShell

Následující příklad používá rutinu Azure PowerShellu Import-AzApiManagementApi k importu specifikace OpenAPI ze zadané adresy URL do instance služby API Management s názvem apim-hello-world. Pokud chcete místo adresy URL importovat cestu ke specifikaci, použijte parametr -SpecificationPath .

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

# API-specific details
$apiId = "demo-conference-api"
$apiPath = "conference"
$specificationFormat = "OpenAPI"
$specificationUrl = "https://conferenceapi.azurewebsites.net/?format=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

Po importu rozhraní API v případě potřeby můžete nastavení aktualizovat pomocí rutiny Set-AzApiManagementApi .

Testování nového rozhraní API na portálu

Operace je možné volat přímo z portálu, což správcům poskytuje pohodlný způsob zobrazení a testování operací rozhraní API.

1. Vyberte rozhraní API, které jste vytvořili v předchozím kroku.

2. Vyberte kartu Test.

3. Vyberte operaci. Stránka zobrazí pole pro parametry dotazu a pole pro hlavičky.

   Poznámka:

   V testovací konzole služba API Management automaticky naplní hlavičku klíče předplatného Ocp-Apim-Subscription-Key a nakonfiguruje klíč předplatného integrovaného předplatného s přístupem. Tento klíč umožňuje přístup ke každému rozhraní API v instanci služby API Management. Volitelně můžete zobrazit hlavičku Ocp-Apim-Subscription-Key výběrem ikony oka vedle požadavku HTTP.

4. V závislosti na operaci zadejte hodnoty parametrů dotazu, hodnoty hlaviček nebo text požadavku. Vyberte Odeslat.

   Když je test úspěšný, back-end odpoví úspěšným kódem odpovědi HTTP a některými daty.

   Tip

   Ve výchozím nastavení testovací konzola odešle požadavek na proxy SERVER CORS služby API Management, který požadavek předá instanci služby API Management, která ji pak předá back-endu. Tento proxy server používá veřejnou IP adresu 13.91.254.72 a může se připojit pouze k veřejným koncovým bodům. Pokud chcete odeslat požadavek přímo z prohlížeče do služby API Management, vyberte Obejít proxy server CORS. Tuto možnost použijte, pokud chcete použít testovací konzolu a brána služby API Management je izolovaná v síti nebo nepovoluje provoz z proxy serveru CORS.

Pokud chcete ladit rozhraní API, projděte si kurz : Ladění rozhraní API pomocí trasování požadavků.

Připojení dalších rozhraní API

Můžete vytvořit rozhraní API rozhraní API vystavených různými službami, mezi které patří:

• Specifikace OpenAPI
• Rozhraní API SOAP
• Rozhraní GraphQL API
• Webová aplikace hostovaná ve službě Aplikace Azure Service
• Aplikace funkcí Azure
• Azure Logic Apps
• Azure Service Fabric

Pomocí následujícího postupu připojte k existujícímu rozhraní API jiné rozhraní API.

Poznámka:

Při importu dalšího rozhraní API se k aktuálnímu rozhraní API připojí příslušné operace.

1. Na webu Azure Portal přejděte do instance Azure API Management.

   

2. Na stránce Přehled nebo v nabídce vlevo vyberte rozhraní API.

   

3. Klikněte na … vedle rozhraní API, ke kterému chcete připojit jiné rozhraní API.

4. V rozevírací nabídce vyberte Importovat.

   

5. Vyberte službu, ze které se má importovat rozhraní API.

   

Příbuzná témata

• Omezení importu rozhraní API
• Import specifikace OpenAPI
• Import rozhraní API protokolu SOAP
• Import rozhraní API protokolu SOAP a převod na REST
• Import rozhraní API služby App Service
• Import rozhraní API kontejnerové aplikace
• Import rozhraní WEBSocket API
• Import rozhraní GraphQL API
• Import schématu GraphQL a nastavení překladačů polí
• Import aplikace Azure Function App
• Import aplikace logiky Azure
• Import služby Service Fabric
• Import rozhraní OData API
• Import metadat SAP OData
• Import rozhraní API gRPC
• Úprava rozhraní API

Ověření ve specifikaci OpenAPI

Zásady ověřování služby API Management můžete nakonfigurovat tak, aby ověřovaly požadavky a odpovědi (nebo prvky z nich) vůči schématu ve specifikaci OpenAPI. Pomocí zásad ověření obsahu můžete například ověřit velikost nebo obsah požadavku nebo textu odpovědi.

Další kroky

• Vytvoření a publikování produktu
• Transformace a ochrana publikovaného rozhraní API