Delen via

De Azure CLI gebruiken om uw API-inventaris te beheren

  • Artikel

In dit artikel wordt beschreven hoe u opdrachten in de Azure CLI gebruikt az apic api om API's toe te voegen en te configureren in uw API Center-inventaris . Gebruik opdrachten in de Azure CLI om scriptbewerkingen uit te voeren om uw API-inventaris en andere aspecten van uw API-centrum te beheren.

Vereisten

  • Een API-centrum in uw Azure-abonnement. Als u er nog geen hebt gemaakt, raadpleegt u quickstart: Uw API-centrum maken.

  • Voor Azure CLI:

    Notitie

    az apic voor opdrachten is de apic-extension Azure CLI-extensie vereist. Als u geen opdrachten hebt gebruikt az apic , kan de extensie dynamisch worden geïnstalleerd wanneer u uw eerste az apic opdracht uitvoert of kunt u de extensie handmatig installeren. Meer informatie over Azure CLI-extensies.

    Zie de releaseopmerkingen voor de meest recente wijzigingen en updates in de apic-extension.

API, API-versie en definitie registreren

De volgende stappen laten zien hoe u een API maakt en één API-versie en API-definitie koppelt. Zie Belangrijke concepten voor achtergrondinformatie over het gegevensmodel in Azure API Center.

Een API maken

Gebruik de opdracht az apic API create om een API te maken in uw API-centrum.

In het volgende voorbeeld wordt een API met de naam Petstore-API gemaakt in de resourcegroep myResourceGroup en het myAPICenter-API-centrum . De API is een REST API.

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

Notitie

Nadat u een API hebt gemaakt, kunt u de eigenschappen van de API bijwerken met behulp van de opdracht az apic API update .

Een API-versie maken

Gebruik de opdracht az apic API version create om een versie voor uw API te maken.

In het volgende voorbeeld wordt een API-versie met de naam v1-0-0 gemaakt voor de petstore-api-API die u in de vorige sectie hebt gemaakt. De versie is ingesteld op de fase van de testlevenscyclus .

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"

API-definitie maken en specificatiebestand toevoegen

Gebruik de opdrachten voor az apic API-definities om een definitie en een bijbehorend specificatiebestand toe te voegen voor een API-versie.

Een definitie maken

In het volgende voorbeeld wordt de opdracht az apic API definition create gebruikt om een definitie met de naam openapi te maken voor de petstore-API-versie die u in de vorige sectie hebt gemaakt.

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"

Een specificatiebestand importeren

Importeer een specificatiebestand naar de definitie met behulp van de opdracht az apic api definition import-specification .

In het volgende voorbeeld wordt een OpenAPI-specificatiebestand geïmporteerd van een openbaar toegankelijke URL naar de openapi-definitie die u in de vorige stap hebt gemaakt. De name en version eigenschappen van de specificatieresource worden doorgegeven als 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

U kunt het specificatiebestand inline importeren door de --format parameter in te inline stellen en de bestandsinhoud door te geven met behulp van de --value parameter.

Een specificatiebestand exporteren

Als u een API-specificatie vanuit uw API-centrum wilt exporteren naar een lokaal bestand, gebruikt u de opdracht az apic api definition export-specification .

In het volgende voorbeeld wordt het specificatiebestand geëxporteerd van de openapi-definitie die u in de vorige sectie hebt gemaakt naar een lokaal bestand met de naam 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"

API registreren vanuit een specificatiebestand - één stap

U kunt in één stap een API registreren vanuit een lokaal specificatiebestand met behulp van de opdracht az apic api register . Met deze optie wordt automatisch een standaard-API-versie en -definitie gemaakt voor de API.

In het volgende voorbeeld wordt een API in het myAPICenter-API-centrum geregistreerd vanuit een lokaal OpenAPI-definitiebestand met de naam specificationFile.json.

az apic api register --resource-group myResourceGroup \
    --service-name myAPICenter --api-location "/Path/to/specificationFile.json"
  • Met de opdracht worden de API-eigenschappen, zoals naam en type, ingesteld op basis van waarden in het definitiebestand.
  • Met de opdracht wordt standaard de levenscyclusfase van de API ingesteld op ontwerp.
  • Er wordt een API-versie gemaakt met de naam volgens de version eigenschap in de API-definitie (of standaard 1-0-0 ) en een API-definitie die is benoemd volgens de specificatieindeling (bijvoorbeeld openapi).

Nadat u een API hebt geregistreerd, kunt u de eigenschappen van de API bijwerken met behulp van de az apic API-update, az apic API-versie-update en az apic API definition update-opdrachten .

API-resources verwijderen

Gebruik de opdracht az apic API delete om een API en alle bijbehorende versie- en definitiebronnen te verwijderen. Voorbeeld:

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

Als u afzonderlijke API-versies en -definities wilt verwijderen, gebruikt u respectievelijk az apic API version delete en az apic API definition delete.

Gerelateerde inhoud