Async API
Oracle GoldenGate Data Streams is programming language agnostic so that it can interact with a client written in any programming language. Even though the client programs typically are simple and small, users still need to manually implement the client code to interact with the data streaming service.
Adopting the AsyncAPI specification into Oracle GoldenGate Data Streams has the following advantages:
-
Ability to describe the data streams service API in industry-standard API specification and automatically generate API documentation.
-
Automatically generate client-side code with
@asyncapi/generator.
With AsyncAPI support, Oracle GoldenGate Data Streams simplifies data streaming by generating the client code automatically. It follows the publisher and subscriber model and support a wide variety of protocols including websocket, kafka, mqtt, hms, and many IOT protocols. When describing an event-driven API, it uses the YAML modeling language and follow similar syntax for OpenAPI specification.
For example, the following snippet of AsyncAPI YAML document describes Data Streaming AsyncAPI definitions:
asyncapi: '3.0.0'
info:
title: Data Streaming API
version: '1.0.0'
description: | allows clients to subscribe to a data stream
license:
name: Apache 2.0
url: 'https://www.apache.org/licenses/LICENSE-2.0'
servers:
EAST:
protocol: ws
url: east.oraclevcn.com:9002
defaultContentType: application/json
channels:
/services/v2/stream/mystream1:
...
When a data streams resource is created, a URL link to a customized Async API specification document describing how to access this data stream endpoint, is returned in the HTTP response. This YAML document can then be used to generate the client-side code using @asyncapi/generator.
Note that to support the websocket protocol in @asyncapi/generator, you also need to implement/maintain the websocket client template for the @asyncapi/generator in GitHub.
Refer to the GitHub repository for more information about the websocket-client-template: