You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* add signu and feedback
* rephrase and added signup
* rephrase message
* rephrase based on PR Agent ai
* rephrase based on PR Agent ai and shorten lines
* Revert "rephrase based on PR Agent ai and shorten lines"
This reverts commit 5826395.
* fix sentence
* Update tyk-docs/content/product-stack/tyk-streaming/overview.md
* Update key-concepts.md
Copy file name to clipboardexpand all lines: tyk-docs/content/product-stack/tyk-streaming/getting-started.md
+25-6
Original file line number
Diff line number
Diff line change
@@ -4,13 +4,24 @@ description: Guide for how to quickly get started using Tyk Streaming
4
4
tags: [ "streaming", "getting started" ]
5
5
---
6
6
7
-
In this guide, you'll learn how to set up Tyk Streams and configure your first asynchronous API. By the end of this guide, you will have a fully functional API that allows you to subscribe to a WebSocket and see the messages you post to Tyk (REST) in real-time.
8
-
9
-
Let's get started and unlock the power of Tyk for your asynchronous API needs!
10
-
7
+
In this guide, you'll learn how to set up Tyk Streams and configure your first asynchronous API. By the end of this
8
+
guide, you will have a fully functional API that allows you to subscribe to a WebSocket and see the messages you post to
9
+
Tyk (REST) in real-time.
10
+
11
+
## Your feedback
12
+
Before you start we have a small request -
13
+
</br>
14
+
Tyk Streams is currently in the
15
+
[Lab Release]({{< ref "developer-support/special-releases-and-features/lab-releases">}}) phase. Your feedback is crucial
16
+
in helping us improve and shape this capability while it’s still in the making. We'd love your input on your experience
17
+
using Tyk Streams, the documentation, learning about your use case, areas for improvement and any other relevant
**You have successfully set up Tyk Streams and created your first async API!**
172
+
{{< /note >}}
158
173
159
174
## Next Steps
160
175
161
-
With this getting started guide, you have successfully set up Tyk Streams and created your first async API! You can now start exploring more [advanced configurations]({{< ref "api-management/async-apis/advanced-use-cases" >}}) and [use cases]({{< ref "api-management/async-apis/use-cases" >}}).
176
+
- Thanks for getting started with Tyk Streams! Please take a moment to share your thoughts and experiences with us
Tyk Streams is currently in the [Lab Release]({{<ref "developer-support/special-releases-and-features/lab-releases">}})
10
+
phase, and we'd love for you to try it out. Click the button to sign up and take it for a spin:
11
+
{{< button_left href="https://survey.hsforms.com/1ItPCBg-_Tre8WFJZL4pp6Q3ifmg" color="green" content="Get started with Tyk Streams" >}}
12
+
13
+
{{< /note >}}
14
+
7
15
<!-- Architectural overview
8
-
- Tyk is now a intermediate broker between broker and subscribers, This is sometimes known as broker proxy
16
+
- Tyk is now an intermediate broker between broker and subscribers, This is sometimes known as broker proxy
9
17
- Integrate with multiple brokers
10
-
- API Management hooks between publisher, gateway and subscriber (Events are availble as APIs)
18
+
- API Management hooks between publisher, gateway, and subscriber (Events are available as APIs)
11
19
12
20
Explain example roles of publisher and subscriber
13
21
@@ -27,43 +35,54 @@ Terms
27
35
28
36
- Example application scenarios
29
37
- IoT
30
-
- Infrastructure for domaindriven design, e.g. event bus to notify state changes between micro-services -->
38
+
- Infrastructure for domain-driven design, e.g. event bus to notify state changes between micro-services -->
31
39
32
-
Tyk Streams seamlessly integrates with the Tyk API Gateway to provide a unified platform for managing both synchronous and asynchronous APIs. This section will provide an overview of the architecture, integration points, and key capabilities. Please consult the [glossary]({{< ref "product-stack/tyk-streaming/glossary" >}}) for explanations of key terminology.
40
+
Tyk Streams seamlessly integrates with the Tyk API Gateway to provide a unified platform for managing both synchronous
41
+
and asynchronous APIs. This section will provide an overview of the architecture, integration points, and key
42
+
capabilities. Please consult the [glossary]({{< ref "product-stack/tyk-streaming/glossary" >}}) for explanations of key
43
+
terminology.
33
44
34
-
Tyk Streams natively integrated as part of Tyk API Gateway and does not have any thirdparty dependencies.
45
+
Tyk Streams is natively integrated as part of Tyk API Gateway and has no third-party dependencies.
35
46
36
47
<!-- <!TODO: Add architectural image> -->
37
-
38
-
The above diagram illustrates the high-level architecture of Tyk Streams and its integration with the Tyk API Gateway. Key components include:
39
-
-**Tyk API Gateway**: The core API management platform that handles API requests, applies policies and routes requests to the appropriate backend services.
40
-
-**Tyk Streams**: An extension to the Tyk API Gateway that enables support for asynchronous APIs and event-driven architectures.
41
-
-**Event Brokers**: External systems such as Apache Kafka, MQTT brokers, or WebSocket servers that produce and consume events.
48
+
<!-- The above diagram illustrates the high-level architecture of Tyk Streams and its integration with the Tyk API Gateway. -->
49
+
Key components in the architecture of Tyk Streams:
50
+
-**Tyk API Gateway**: The core API management platform that handles API requests, applies policies, and routes requests
51
+
to the appropriate backend services.
52
+
-**Tyk Streams**: An extension to the Tyk API Gateway that enables support for asynchronous APIs and event-driven
53
+
architectures.
54
+
-**Event Brokers**: External systems such as Apache Kafka, MQTT brokers, or WebSocket servers that produce and consume
55
+
events.
42
56
-**Backend Services**: The underlying services and systems that expose APIs or consume events.
43
57
44
-
## Integration with Tyk API Gateway
58
+
## Tyk Streams as middleware in Tyk API Gateway
45
59
46
-
Tyk Streams integrates with the Tyk API Gateway through the following mechanisms:
60
+
Tyk Streams operates as middleware within the Tyk API Gateway, providing the following functionalities:
47
61
48
-
-**API Definitions**: Tyk Streams are defined using the standard Tyk OpenAPI API definition format, with additional fields specific to async protocols and event configurations.
49
-
-**Middleware**: Tyk Streams introduces new middleware components that handle async-specific functionality such as protocol mediation, event transformations and pub/sub messaging.
50
-
-**Analytics**: Async API traffic is captured and reported via Prometheus, OpenTelementry or StatsD, providing visibility into usage, performance, and errors.
62
+
-**Middleware**: Tyk Streams introduces new middleware components that handle async-specific functionality such as
63
+
protocol mediation, event transformations, and pub/sub messaging.
64
+
-**API Definitions**: Tyk Streams is configured using the standard Tyk OAS format, including additional fields tailored
65
+
for async protocols and event configurations.
66
+
-**Analytics**: Async API traffic is captured and reported via *Prometheus*, *OpenTelemetry* or *StatsD*, providing
67
+
visibility into usage, performance, and errors.
51
68
52
69
## Connectors and Protocol Mediation
53
70
54
71
Tyk Streams provides out-of-the-box connectors for popular event brokers and async protocols, including:
55
72
56
-
- Apache Kafka
57
-
- MQTT
58
-
- RabbitMQ
59
-
- Solate
60
-
- RedPanda
61
-
- AMQP
62
-
- WebSocket
63
-
- Server-Sent Events (SSE)
64
-
- Webhooks
65
-
66
-
In addition to the native protocol support, Tyk Streams offers powerful protocol mediation capabilities. This allows you to expose async APIs using different protocols than the backend event broker, making it easier to support diverse client requirements.
We are excited to introduce our new product, *Tyk Streams*!
7
-
*Tyk Streams* is a powerful new feature in the Tyk API management platform that enables organisations to securely expose, manage and monetize real-time event streams and asynchronous APIs. With *Tyk Streams*, you can easily connect to various event brokers and streaming platforms, such as [Apache Kafka](https://github.com/TykTechnologies/tyk-pro-docker-demo/tree/kafka), MQTT, AMQP etc. and expose them as managed API endpoints to internal and external consumers.
7
+
*Tyk Streams* is a powerful new feature in the Tyk API management platform that enables organisations to securely expose,
8
+
manage and monetize real-time event streams and asynchronous APIs.
9
+
10
+
## Getting started
11
+
12
+
Tyk Streams is currently in the [Lab Release]({{<ref "developer-support/special-releases-and-features/lab-releases">}})
13
+
phase, and we'd love for you to try it out. Click the button to sign up and take it for a spin:
14
+
{{< button_left href="https://survey.hsforms.com/1ItPCBg-_Tre8WFJZL4pp6Q3ifmg" color="green" content="Get started with Tyk Streams" >}}
15
+
16
+
---
17
+
## Overview
18
+
With *Tyk Streams*, you can easily connect to various event brokers and streaming platforms, such as
19
+
[Apache Kafka](https://github.com/TykTechnologies/tyk-pro-docker-demo/tree/kafka), MQTT, AMQP etc. and expose them as
20
+
managed API endpoints to internal and external consumers.
The purpose of Tyk Streams is to provide a unified platform for managing both synchronous APIs (such as REST and GraphQL) and asynchronous APIs, in addition to event-driven architectures. This allows organisations to leverage the full potential of their event-driven systems while maintaining the same level of security, control and visibility they expect from their API management solution.
26
+
The purpose of Tyk Streams is to provide a unified platform for managing both synchronous APIs (such as REST and
27
+
GraphQL) and asynchronous APIs, in addition to event-driven architectures. This allows organisations to leverage the
28
+
full potential of their event-driven systems while maintaining the same level of security, control and visibility they
29
+
expect from their API management solution.
14
30
15
31
</br>
16
32
17
33
{{< warning success>}}
18
34
19
35
**Important notice: Tyk Stream in Lab Release**
20
36
21
-
*Tyk Streams* is currently in the *Lab Release* phase. It is under active development and testing, and is not intended for production use. For more details and to provide your feedback, please visit our [Lab Release Information Page]({{< ref "developer-support/special-releases-and-features/lab-releases" >}}).
37
+
*Tyk Streams* is currently in the *Lab Release* phase. It is under active development and testing, and is not intended
38
+
for production use. For more details and to provide your feedback, please visit our
39
+
[Lab Release Information Page]({{< ref "developer-support/special-releases-and-features/lab-releases" >}}).
22
40
23
41
</br>
24
42
@@ -28,7 +46,8 @@ The purpose of Tyk Streams is to provide a unified platform for managing both sy
28
46
29
47
## How Tyk Streams Enables Async API Support?
30
48
31
-
Tyk Streams seamlessly integrates with the Tyk API Gateway, allowing you to manage asynchronous APIs and event streams alongside your existing synchronous APIs. It provides a range of capabilities to support async API management, including:
49
+
Tyk Streams seamlessly integrates with the Tyk API Gateway, allowing you to manage asynchronous APIs and event streams
50
+
alongside your existing synchronous APIs. It provides a range of capabilities to support async API management, including:
32
51
33
52
-**Protocol Mediation**: Tyk Streams can mediate between different asynchronous protocols and API styles, such as WebSocket, Server-Sent Events (SSE) and Webhooks. This allows you to expose your event streams in a format that is compatible with your consumers' requirements.
34
53
-**Security**: Apply the same security policies and controls to your async APIs as you do to your synchronous APIs. This includes features like authentication and authorization.
@@ -39,7 +58,8 @@ Tyk Streams seamlessly integrates with the Tyk API Gateway, allowing you to mana
39
58
40
59
#### Configuration as Code
41
60
42
-
Tyk Streams configuration natively integrates with our OpenAPI format. This enables a *configuration-as-code* approach, where async API definitions can be version-controlled, collaborated on and deployed using GitOps workflows.
61
+
Tyk Streams configuration natively integrates with Tyk OAS (our OpenAPI format for APIs), enabling *configuration-as-code*
62
+
approach. This allows async API definitions to be version-controlled, collaborated on and deployed using GitOps workflows.
43
63
44
64
```yaml
45
65
{
@@ -76,20 +96,24 @@ Tyk Streams configuration natively integrates with our OpenAPI format. This enab
76
96
77
97
## Configuring Async APIs via Dashboard UI
78
98
79
-
The Tyk Dashboard provides a user-friendly interface for defining and managing async APIs. You can easily specify event broker details, subscribe to specific topics or channels, configure security policies, transformations and other API management capabilities.
99
+
The Tyk Dashboard provides a user-friendly interface for defining and managing async APIs. You can easily specify event
100
+
broker details, subscribe to specific topics or channels, configure security policies, transformations and other API
101
+
management capabilities.
80
102
81
-
{{< img src="/img/streams/configure-streams.png" alt="Tyk Dashboard API Streams" width="1000px" >}}
103
+
{{< img src="/img/streams/configure-streams.png" alt="Screenshot of Tyk Dashboard configuring API Streams" width="1000px" >}}
82
104
83
105
---
84
106
85
107
## Comparison to Other Products
86
108
87
-
While some API management platforms offer basic support for async APIs and event-driven architectures, Tyk Streams stands out by providing a comprehensive and flexible solution:
109
+
While some API management platforms offer basic support for async APIs and event-driven architectures, Tyk Streams
110
+
stands out by providing a comprehensive and flexible solution:
88
111
89
112
-**Extensive protocol support**: Tyk Streams supports a wide range of event brokers and protocols out of the box, including Kafka, MQTT, WebSocket, and more.
90
113
-**Powerful mediation capabilities**: Tyk Streams allows you to transform and enrich event data, enabling protocol mediation and compatibility with diverse client requirements.
91
114
-**Seamless integration**: Async APIs are managed alongside synchronous APIs within the Tyk platform, providing a unified developer portal, consistent security policies and centralised analytics.
92
115
-**Flexibility and scalability**: Tyk Streams can be deployed in various architectures, from simple single-node setups to large-scale distributed deployments and can handle high-throughput event processing scenarios.
93
116
94
-
By leveraging Tyk Streams, organisations can unlock the full potential of their event-driven architectures while benefiting from the robust API management capabilities of the Tyk platform.
117
+
By leveraging Tyk Streams, organisations can unlock the full potential of their event-driven architectures while
118
+
benefiting from the robust API management capabilities of the Tyk platform.
0 commit comments