Relationships between resources 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 standard. In API Gateway, the specification is supplemented with extensions that you can use for integrating with other cloud platforms.
Available extensions:
- Static response.
- Invoking a function.
- Access over HTTP.
- Integration with Object Storage.
- Integration with DataSphere.
- Integration with Data Streams.
- Integration with Serverless Containers.
- Integration with Message Queue.
- Greedy parameters.
- Generalized HTTP method.
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 services from Yandex Cloud.
Authorization
API Gateway enables you to implement standard authentication and authorization mechanisms as described in the OpenAPI 3.0 specification. At present, authorization using a function is available.
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 protocol. Clients can send messages to an API gateway, which in turn can independently send messages to client applications. That means clients can receive data without having to make an HTTP request. Web sockets are often used in applications that require real-time data updates, such as messengers and online chats, multiplayer games, collaboration tools, trading apps, and sports betting services.
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.