Настроить переменные
Сервис API Gateway поддерживает использование переменных в спецификации OpenAPI.
Пример файла спецификации с переменной
openapi: 3.0.0
info:
title: Sample API
version: 1.0.0
x-yc-apigateway:
variables:
environment:
default: "prod"
enum:
- "prod"
- "testing"
- "dev"
description: "API Gateway installation."
paths:
/env/info:
get:
x-yc-apigateway-integration:
type: dummy
content:
'*': It is ${var.environment} environment!
http_code: 200
http_headers:
Content-Type: text/plain
По умолчанию переменные принимают значения, которые указаны в поле default в спецификации OpenAPI. Вы можете переопределить их, передав другие значения при настройке API-шлюза:
- В консоли управления перейдите в каталог, в котором необходимо изменить API-шлюз.
- В списке сервисов выберите API Gateway.
- В строке с API-шлюзом нажмите кнопку и выберите Редактировать.
- В блоке Управление переменными перечислите все объявленные в спецификации переменные и их значения.
- Нажмите кнопку Сохранить.
Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.
По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.
Чтобы настроить переменные:
-
При необходимости внесите изменения в файл спецификации OpenAPI или подготовьте новый файл.
-
Посмотрите описание команды CLI для изменения API-шлюза:
yc serverless api-gateway update --help -
Укажите в команде идентификатор или имя API-шлюза, а также список всех объявленных в спецификации переменных в формате
ключ=значение:yc serverless api-gateway update \ --id <идентификатор_API-шлюза> \ --variables <список_переменных>
Terraform позволяет быстро создать облачную инфраструктуру в Yandex Cloud и управлять ею с помощью файлов конфигураций. В файлах конфигураций хранится описание инфраструктуры на языке HCL (HashiCorp Configuration Language). При изменении файлов конфигураций Terraform автоматически определяет, какая часть вашей конфигурации уже развернута, что следует добавить или удалить.
Terraform распространяется под лицензией Business Source License, а провайдер Yandex Cloud для Terraform — под лицензией MPL-2.0.
Подробную информацию о ресурсах провайдера смотрите в документации на сайте Terraform или в зеркале.
Если у вас еще нет Terraform, установите его и настройте провайдер Yandex Cloud.
Чтобы передать значения переменных, объявленных в спецификации API-шлюза:
-
Откройте файл конфигурации Terraform и добавьте в него блок
variables:resource "yandex_api_gateway" "<имя_API-шлюза>" { ... variables = { <список_переменных> } ... }Список переменных задается в формате
ключ = значение, например:resource "yandex_api_gateway" "<имя_API-шлюза>" { ... variables = { environment = "testing" } ... } -
Проверьте конфигурацию командой:
terraform validateЕсли конфигурация является корректной, появится сообщение:
Success! The configuration is valid. -
Выполните команду:
terraform planВ терминале будет выведен список ресурсов с параметрами. На этом этапе изменения не будут внесены. Если в конфигурации есть ошибки, Terraform на них укажет.
-
Примените изменения конфигурации:
terraform apply -
Подтвердите изменения: введите в терминал слово
yesи нажмите Enter.Проверить, что API-шлюз изменился, можно в консоли управления или с помощью команды CLI:
yc serverless api-gateway get <имя_API-шлюза>
Чтобы настроить переменные для спецификации API-шлюза, воспользуйтесь методом REST API update для ресурса ApiGateway или вызовом gRPC API ApiGatewayService/Update.