Open Source API Gateway

sseDemoStream

Version

Demo interceptor that streams a Server-Sent Events (SSE) response, emitting one JSON event per interval, for testing or demonstration purposes.

See tutorials/sse/10-Server-Sent-Events.yaml.

Example Configuration

api:
port: 2000
path:
uri: /stream
flow:
- sseDemoStream:
totalEvents: 10
api:
   port: 2000
   path:
     uri: /stream
   flow:
     - sseDemoStream:
         totalEvents: 10

Syntax

sseDemoStream:
intervalSeconds: <int>
totalEvents: <int>
sseDemoStream:
  intervalSeconds: <int>
  totalEvents: <int>

Attributes

NameRequiredDefaultDescriptionExamples
intervalSecondsfalse1Seconds to wait between events.-
totalEventsfalse3600Total number of events to send before the stream ends.-

Can be used in