Поделиться через

Управление инвентаризацией API с помощью Azure CLI

  • Статья

В этой статье показано, как использовать az apic api команды в Azure CLI для добавления и настройки API в инвентаризации центра API. Используйте команды в Azure CLI для управления инвентаризацией API и другими аспектами центра API.

Необходимые компоненты

  • Центр API в подписке Azure. Если вы еще не создали его, см . краткое руководство. Создание центра API.

  • При использовании Azure CLI выполните следующее:

    • Используйте среду Bash в Azure Cloud Shell. Дополнительные сведения см . в кратком руководстве по Bash в Azure Cloud Shell.

    • Если вы предпочитаете выполнять справочные команды CLI локально, установите Azure CLI. Если вы работаете в Windows или macOS, Azure CLI можно запустить в контейнере Docker. Дополнительные сведения см. в статье Как запустить Azure CLI в контейнере Docker.

      • Если вы используете локальную установку, выполните вход в Azure CLI с помощью команды az login. Чтобы выполнить аутентификацию, следуйте инструкциям в окне терминала. Сведения о других возможностях, доступных при входе, см. в статье Вход с помощью Azure CLI.

      • Установите расширение Azure CLI при первом использовании, когда появится соответствующий запрос. Дополнительные сведения о расширениях см. в статье Использование расширений с Azure CLI.

      • Выполните команду az version, чтобы узнать установленную версию и зависимые библиотеки. Чтобы обновиться до последней версии, выполните команду az upgrade.

    Примечание.

    az apic для команд требуется apic-extension расширение Azure CLI. Если вы не использовали az apic команды, расширение можно установить динамически при выполнении первой az apic команды или установить расширение вручную. Дополнительные сведения о расширениях Azure CLI.

    Дополнительные сведения о последних изменениях и обновлениях см. в заметках о выпускеapic-extension. Для некоторых функций может потребоваться предварительная версия или определенная версия расширения.

Регистрация API, версии API и определения

Ниже показано, как создать API и связать одну версию API и определение API. Общие сведения о модели данных в Центре API Azure см. в основных понятиях.

Создание API

Используйте команду az apic create, чтобы создать API в центре API.

В следующем примере создается API с именем API Petstore в группе ресурсов myResourceGroup и центре API myAPICenter . API — это REST API.

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

Создание версии API

Используйте команду az apic api create, чтобы создать версию для API.

В следующем примере создается версия API с именем 1-0-0 для API petstore-api , созданного в предыдущем разделе. Версия устанавливается на этап жизненного цикла тестирования .

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 и добавление файла спецификации

Используйте команды определения api az api для добавления определения определения и соответствующего файла спецификации для версии API.

Создание определения

В следующем примере используется команда az apic api create для создания определения с именем openapi для версии API petstore-api , созданной в предыдущем разделе.

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"

Импорт файла спецификации

Импортируйте файл спецификации в определение с помощью команды az apic api definition import-specification .

В следующем примере импортируется файл спецификации OpenAPI из общедоступного URL-адреса в определение openapi , созданное на предыдущем шаге. version Свойства name ресурса спецификации передаются в формате 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"}'

Совет

Вы можете импортировать встроенный файл спецификации, задав --format параметр inline и передав содержимое файла с помощью --value параметра.

Экспорт файла спецификации

Чтобы экспортировать спецификацию API из центра API в локальный файл, используйте команду az apic api definition export-specification .

В следующем примере файл спецификации экспортируется из определения openapi , созданного в предыдущем разделе, в локальный файл с именем 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 из файла спецификации — один шаг

Вы можете зарегистрировать API из локального файла спецификации на одном шаге с помощью команды az apic api register . С помощью этого параметра версия и определение API по умолчанию создаются автоматически для API.

Следующий пример регистрирует API в центре API myAPICenter из локального файла определения OpenAPI с именем specificationFile.json.

az apic api register --resource-group myResourceGroup \
    --service-name myAPICenter --api-location "/Path/to/specificationFile.json"
  • Команда задает свойства API, такие как имя и тип из значений в файле определения.
  • По умолчанию команда задает этап жизненного цикла API для разработки.
  • Он создает версию API с именем в соответствии со version свойством в определении API (или 1-0-0 по умолчанию) и определение API с именем в соответствии с форматом спецификации (например, openapi).

Обновление свойств API

После регистрации API можно обновить свойства API с помощью az api update, az apic api version update и az apic api update и az apic api definition updates .

В следующем примере заголовок API petstore-api обновляется до API Petstore версии 2.

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

В следующем примере логическое свойство API настраивается как false.

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

Удаление ресурсов API

Используйте команду az apic delete, чтобы удалить API и все его ресурсы версии и определения. Например:

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

Чтобы удалить отдельные версии и определения API, используйте az apic api version delete и az apic api definition delete соответственно.

Связанный контент