Sdílet prostřednictvím

Použití Azure CLI ke správě inventáře rozhraní API

V tomto článku se dozvíte, jak pomocí příkazů az apic api v Azure CLI přidat a nakonfigurovat rozhraní API v inventáři služby Azure API Center . Pomocí příkazů v Azure CLI můžete skriptovat operace pro správu inventáře rozhraní API a dalších aspektů centra rozhraní API.

Požadavky

  • Centrum rozhraní API ve vašem předplatném Azure. Pokud jste ho ještě nevytvořili, přečtěte si článek Rychlý start: Vytvoření centra rozhraní API.

  • Pro Azure CLI:

    Poznámka:

    az apic příkazy vyžadují apic-extension rozšíření Azure CLI. Pokud jste nepoužili az apic příkazy, můžete rozšíření nainstalovat dynamicky při spuštění prvního az apic příkazu nebo rozšíření nainstalovat ručně. Přečtěte si další informace o rozšířeních Azure CLI.

    Podívejte se na poznámky k verzi nejnovějších změn a aktualizací v nástroji apic-extension. Některé funkce můžou vyžadovat verzi Preview nebo konkrétní verzi rozšíření.

Registrace rozhraní API, verze rozhraní API a definice

Následující kroky ukazují, jak vytvořit rozhraní API a přidružit jednu verzi rozhraní API a definici rozhraní API. Základní informace o datovém modelu ve službě Azure API Center najdete v tématu Klíčové koncepty.

Vytvoření rozhraní API

Pomocí příkazu az apic api create vytvořte rozhraní API v centru rozhraní API.

Následující příklad vytvoří rozhraní API s názvem Petstore API ve skupině prostředků myResourceGroup a centru rozhraní API myAPICenter . Rozhraní API je rozhraní REST API.

az apic api create  --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --title "Petstore API" --type "rest"

Vytvoření verze rozhraní API

K vytvoření verze rozhraní API použijte příkaz az apic api version create.

Následující příklad vytvoří verzi rozhraní API s názvem v1-0-0 pro rozhraní API petstore-api , které jste vytvořili v předchozí části. Verze je nastavená na fázi testovacího životního cyklu.

az apic api version create --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --version-id v1-0-0 --title "v1-0-0" --lifecycle-stage "testing"

Vytvoření definice rozhraní API a přidání souboru specifikace

Příkazy az apic api definition použijte k přidání definice a doprovodného souboru specifikace pro verzi rozhraní API.

Vytvoření definice

Následující příklad používá příkaz az apic api definition create k vytvoření definice s názvem openapi pro verzi rozhraní API petstore-api , kterou jste vytvořili v předchozí části.

az apic api definition create --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --version-id v1-0-0 --definition-id openapi --title "OpenAPI"

Import souboru specifikace

Importujte soubor specifikace do definice pomocí příkazu az apic api definition import-specification .

Následující příklad naimportuje soubor specifikace OpenAPI z veřejně přístupné adresy URL do definice openapi , kterou jste vytvořili v předchozím kroku. Prostředky name specifikace a version vlastnosti se předávají jako JSON.

az apic api definition import-specification \
    --resource-group myResourceGroup --service-name myAPICenter \
    --api-id petstore-api --version-id v1-0-0 \
    --definition-id openapi --format "link" \
    --value 'https://petstore3.swagger.io/api/v3/openapi.json' \
    --specification '{"name":"openapi","version":"3.0.2"}'

Tip

Soubor specifikace můžete importovat přímo nastavením --format parametru a inline předáním obsahu souboru pomocí parametru --value .

Export souboru specifikace

Pokud chcete exportovat specifikaci rozhraní API z centra rozhraní API do místního souboru, použijte příkaz az apic api definition export-specification .

Následující příklad exportuje soubor specifikace z definice openapi , kterou jste vytvořili v předchozí části, do místního souboru s názvem specificationFile.json.

az apic api definition export-specification \
    --resource-group myResourceGroup --service-name myAPICenter \
    --api-id petstore-api --version-id v1-0-0 \
    --definition-id openapi --file-name "/Path/to/specificationFile.json"

Registrace rozhraní API ze souboru specifikace – jeden krok

Pomocí příkazu az apic api register můžete zaregistrovat rozhraní API z místního souboru specifikace v jednom kroku. Pomocí této možnosti se pro rozhraní API vytvoří automaticky výchozí verze a definice rozhraní API.

Následující příklad zaregistruje rozhraní API v centru rozhraní API myAPICenter z místního definičního souboru OpenAPI s názvem specificationFile.json.

az apic api register --resource-group myResourceGroup \
    --service-name myAPICenter --api-location "/Path/to/specificationFile.json"
  • Příkaz nastaví vlastnosti rozhraní API, jako je název a typ z hodnot v definičním souboru.
  • Ve výchozím nastavení příkaz nastaví fázi životního cyklu rozhraní API tak, aby se navrhla.
  • Vytvoří verzi rozhraní API pojmenovanou podle version vlastnosti v definici rozhraní API (nebo ve výchozím nastavení 1-0-0 ) a definici rozhraní API pojmenovanou podle formátu specifikace (například openapi).

Aktualizace vlastností rozhraní API

Po registraci rozhraní API můžete aktualizovat vlastnosti rozhraní API pomocí příkazu az apic api update, az apic api version update a az apic api definition update commands.

Následující příklad aktualizuje název rozhraní API petstore-api na petstore API v2.

az apic api update --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --title "Petstore API v2"

Následující příklad nastaví logickou internal vlastní vlastnost rozhraní API na false.

az apic api update --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --set custom_properties.internal=false

Odstranění prostředků rozhraní API

Pomocí příkazu az apic api delete odstraňte rozhraní API a všechny jeho prostředky verze a definice. Příklad:

az apic api delete \
    --resource-group myResourceGroup --service-name myAPICenter \
    --api-id petstore-api

Pokud chcete odstranit jednotlivé verze a definice rozhraní API, použijte příkaz az apic api version delete a az apic api definition delete.

Související obsah

  • Last updated on