Updating an API gateway
After you create an API gateway, you can change any of its parameters and the OpenAPI specification
-
In the management console
, go to the folder where you want to update an API gateway. -
In the list of services, select API Gateway.
-
In the API gateway row, click
and select Edit. -
Edit the API gateway parameters or OpenAPI specification if needed.
To add the x-yc-apigateway-integration extension to a specification, you can use the specification constructor.
-
Click Save.
If you do not have the Yandex Cloud command line interface yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name
or --folder-id
parameter.
To update an API gateway:
-
If necessary, edit the OpenAPI specification file or create a new one.
-
View a description of the CLI command for updating an API gateway:
yc serverless api-gateway update --help
-
In the update command, specify the API gateway ID or name and the parameters to update (not all the supported parameters are listed below):
yc serverless api-gateway update \ --id <gateway_ID> \ --new-name <new_gateway_name> \ --spec=<new_specification_file_path>
Terraform
For more information about the provider resources, see the documentation on the Terraform
If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.
If you don't have Terraform, install it and configure the Yandex Cloud provider.
To change the name, description, or specification of the API gateway:
-
Open the Terraform configuration file and change the
name
,description
, orspec
parameters.Here is an example of the configuration file structure:
... resource "yandex_api_gateway" "test-api-gateway" { name = "some_name" description = "any description" labels = { label = "label" empty-label = "" } spec = <<-EOT openapi: "3.0.0" info: version: 1.0.0 title: Test API paths: /hello: get: summary: Say hello operationId: hello parameters: - name: user in: query description: User name to appear in greetings. required: false schema: type: string default: 'world' responses: '200': description: Greeting. content: 'text/plain': schema: type: "string" x-yc-apigateway-integration: type: dummy http_code: 200 http_headers: 'Content-Type': "text/plain" content: 'text/plain': "Hello again, {user}!\n" EOT } ...
For more information about the
yandex_api_gateway
resource parameters in Terraform, see the provider documentation . -
Check the configuration using this command:
terraform validate
If the configuration is correct, you will get this message:
Success! The configuration is valid.
-
Run this command:
terraform plan
The terminal will display a list of resources with parameters. No changes will be made at this step. If the configuration contains any errors, Terraform will point them out.
-
Apply the configuration changes:
terraform apply
-
Confirm the changes: type
yes
into the terminal and press Enter.You can check the API gateway update using the management console
or this CLI command:yc serverless api-gateway get <API_gateway_name>
To change the API gateway name, description, or specification, use the update REST API method for the ApiGateway resource or the ApiGatewayService/Update gRPC API call.
You can edit the name, description, or specification of an API gateway using the Yandex Cloud Toolkit plugin