Zarządzanie spisem interfejsu API przy użyciu interfejsu wiersza polecenia platformy Azure

  • Artykuł

W tym artykule pokazano, jak używać az apic api poleceń w interfejsie wiersza polecenia platformy Azure do dodawania i konfigurowania interfejsów API w spisie centrum interfejsu API. Polecenia w interfejsie wiersza polecenia platformy Azure umożliwiają wykonywanie skryptów w celu zarządzania spisem interfejsu API i innymi aspektami centrum interfejsu API.

Wymagania wstępne

Rejestrowanie interfejsu API, wersji interfejsu API i definicji

W poniższych krokach pokazano, jak utworzyć interfejs API i skojarzyć pojedynczą wersję interfejsu API i definicję interfejsu API. Aby uzyskać podstawowe informacje na temat modelu danych w centrum interfejsów API platformy Azure, zobacz Kluczowe pojęcia.

Tworzenie interfejsu API

Użyj polecenia az apic api create, aby utworzyć interfejs API w centrum interfejsu API.

Poniższy przykład tworzy interfejs API o nazwie Petstore API w grupie zasobów myResourceGroup i centrum interfejsu API myAPICenter . Interfejs API jest interfejsem API REST.

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

Uwaga

Po utworzeniu interfejsu API można zaktualizować właściwości interfejsu API przy użyciu polecenia az apic api update .

Tworzenie wersji interfejsu API

Użyj polecenia az apic api version create, aby utworzyć wersję interfejsu API.

Poniższy przykład tworzy wersję interfejsu API o nazwie v1-0-0 dla interfejsu API petstore-api utworzonego w poprzedniej sekcji. Wersja jest ustawiona na etap cyklu życia testowania.

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

Tworzenie definicji interfejsu API i dodawanie pliku specyfikacji

Użyj poleceń az apic api definition, aby dodać definicję i towarzyszący plik specyfikacji dla wersji interfejsu API.

Tworzenie definicji

W poniższym przykładzie użyto polecenia az apic api definition create , aby utworzyć definicję o nazwie openapi dla wersji interfejsu API magazynu petstore-api utworzonej w poprzedniej sekcji.

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

Importowanie pliku specyfikacji

Zaimportuj plik specyfikacji do definicji przy użyciu polecenia az apic api definition import-specification .

Poniższy przykład importuje plik specyfikacji Interfejsu OpenAPI z publicznie dostępnego adresu URL do definicji interfejsu Openapi utworzonej w poprzednim kroku. Właściwości name i version zasobu specyfikacji są przekazywane jako dane JSON.

az apic api definition import-specification \
    --resource-group myResourceGroup --service 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"}'

Napiwek

Plik specyfikacji można zaimportować w tekście, ustawiając --format parametr na inline i przekazując zawartość pliku przy użyciu parametru --value .

Eksportowanie pliku specyfikacji

Aby wyeksportować specyfikację interfejsu API z centrum interfejsu API do pliku lokalnego, użyj polecenia az apic api definition export-specification .

Poniższy przykład eksportuje plik specyfikacji z definicji openapi utworzonej w poprzedniej sekcji do pliku lokalnego o nazwie specificationFile.json.

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

Rejestrowanie interfejsu API z pliku specyfikacji — pojedynczy krok

Interfejs API można zarejestrować w pliku specyfikacji lokalnej w jednym kroku za pomocą polecenia az apic api register . Dzięki tej opcji domyślna wersja i definicja interfejsu API są tworzone automatycznie dla interfejsu API.

Poniższy przykład rejestruje interfejs API w centrum interfejsu API myAPICenter z lokalnego pliku definicji interfejsu OpenAPI o nazwie specificationFile.json.

az apic api register --resource-group myResourceGroup \
    --service myAPICenter --api-location "/Path/to/specificationFile.json"
  • Polecenie ustawia właściwości interfejsu API, takie jak nazwa i typ z wartości w pliku definicji.
  • Domyślnie polecenie ustawia etap cyklu życia interfejsu API na projekt.
  • Tworzy domyślną wersję interfejsu API o nazwie 1-0-0 i domyślną definicję o nazwie zgodnie z formatem specyfikacji (na przykład openapi).

Po zarejestrowaniu interfejsu API można zaktualizować właściwości interfejsu API przy użyciu poleceń az apic api update, az apic api version update i az apic api definition update .

Usuwanie zasobów interfejsu API

Użyj polecenia az apic api delete, aby usunąć interfejs API i wszystkie jego wersje i zasoby definicji. Na przykład:

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

Aby usunąć poszczególne wersje i definicje interfejsu API, użyj polecenia az apic api version delete i az apic api definition delete, odpowiednio.

Powiązana zawartość