Dela via

Använda Azure CLI för att hantera ditt API-lager

  • Artikel

Den här artikeln visar hur du använder az apic api kommandon i Azure CLI för att lägga till och konfigurera API:er i API Center-inventeringen . Använd kommandon i Azure CLI för att skriptåtgärder för att hantera API-inventeringen och andra aspekter av DITT API Center.

Förutsättningar

Registrera API, API-version och definition

Följande steg visar hur du skapar ett API och associerar en enskild API-version och API-definition. Bakgrund om datamodellen i Azure API Center finns i Viktiga begrepp.

Skapa ett API

Använd kommandot az apic api create för att skapa ett API i api-centret.

I följande exempel skapas ett API med namnet Petstore API i resursgruppen myResourceGroup och api-centret myAPICenter . API:et är ett REST-API.

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

Kommentar

När du har skapat ett API kan du uppdatera API:ets egenskaper med hjälp av kommandot az apic api update .

Skapa en API-version

Använd kommandot az apic api version create för att skapa en version för ditt API.

I följande exempel skapas en API-version med namnet v1-0-0 för api:et petstore-api som du skapade i föregående avsnitt. Versionen är inställd på testlivscykelsteget .

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"

Skapa API-definition och lägg till specifikationsfil

Använd definitionskommandona az apic api för att lägga till en definition och en tillhörande specifikationsfil för en API-version.

Skapa en definition

I följande exempel används kommandot az apic api definition create för att skapa en definition med namnet openapi för api-versionen för petstore-api som du skapade i föregående avsnitt.

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"

Importera en specifikationsfil

Importera en specifikationsfil till definitionen med kommandot az apic api definition import-specification .

I följande exempel importeras en OpenAPI-specifikationsfil från en offentligt tillgänglig URL till openapi-definitionen som du skapade i föregående steg. Egenskaperna name och version för specifikationsresursen skickas som 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"}'

Dricks

Du kan importera specifikationsfilen infogad genom att ange parametern --format till inline och skicka filinnehållet med hjälp av parametern --value .

Exportera en specifikationsfil

Om du vill exportera en API-specifikation från api-centret till en lokal fil använder du kommandot az apic api definition export-specification .

I följande exempel exporteras specifikationsfilen från openapi-definitionen som du skapade i föregående avsnitt till en lokal fil med namnet 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"

Registrera API från en specifikationsfil – ett steg

Du kan registrera ett API från en lokal specifikationsfil i ett enda steg med hjälp av kommandot az apic api register . Med det här alternativet skapas en standard-API-version och definition automatiskt för API:et.

I följande exempel registreras ett API i API-centret myAPICenter från en lokal OpenAPI-definitionsfil med namnet specificationFile.json.

az apic api register --resource-group myResourceGroup \
    --service-name myAPICenter --api-location "/Path/to/specificationFile.json"
  • Kommandot anger API-egenskaperna, till exempel namn och typ från värden i definitionsfilen.
  • Som standard anger kommandot API:ets livscykelfas som design.
  • Den skapar en API-version med namnet enligt version egenskapen i API-definitionen (eller 1-0-0 som standard) och en API-definition med namnet enligt specifikationsformatet (till exempel openapi).

När du har registrerat ett API kan du uppdatera API:ets egenskaper med hjälp av az apic api update, az apic api version update och az apic api definition update commands.

Ta bort API-resurser

Använd kommandot az apic api delete för att ta bort ett API och alla dess versions- och definitionsresurser. Till exempel:

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

Om du vill ta bort enskilda API-versioner och definitioner använder du az apic api version delete respektive az apic api definition delete.

Relaterat innehåll