Resource relationships in API Gateway
API gateway is an interface for interacting with services in Yandex Cloud or on the internet.
API gateways are set in a declarative way using specifications. A specification is a JSON or YAML file with an API gateway description based on the OpenAPI 3.0
Available extensions:
- Static response
- Access over HTTP
- Integration with Cloud Functions
- Integration with Serverless Containers
- Integration with Object Storage
- Integration with DataSphere
- Integration with Data Streams
- Integration with Message Queue
- Integration with YDB
- Greedy parameters
- Generalized HTTP method
- Authorization using a Cloud Functions function
- Authorization using a JWT
- WebSocket protocol support
- Data validation
- CORS support
- Specification parameterization
- Canary release
- Request rate limit
Using domains
API Gateway is integrated with the Certificate Manager domain management system.
You can use domains with confirmed rights when accessing the API. In this case, a certificate linked to the domain is used to provide a TLS connection.
For more information about domains, see Integration of the domain management system with Yandex Cloud services.
Authorization
API Gateway enables you to implement standard authentication and authorization mechanisms
WebSocket
Note
This feature is in the Preview stage.
For two-way asynchronous communication between clients and an API gateway, API Gateway supports the WebSocket
To connect to an API gateway using the WebSocket protocol, you can use a service domain allocated during the creation of the API gateway or any other domain added to the API gateway.
Integrations are supported for the following events:
- Opening a connection.
- Sending messages via a web socket.
- Closing a connection.
To set up integrations, there are special extensions of the OpenAPI specification.
You can manage web sockets using the API that receives information about a connection, sends data to the client's side, and closes the connection.
For limits related to WebSocket support, see Quotas and limits.
Example of a serverless WebSocket app