Documentation for server sent events

Servicestack is having wonderful service documentation support. Like swagger and postman plugin. It also allows client to figure it out based on message (poco).

Same thing is possible for server events? Means if I am doing something via events only, then how can I document it? So, client or api consumer can get details of it?

Please let me now if any further details are required.

No there’s no metadata API documentation for Server Events nor is there any concept/standard for doing so.

I would show with examples how to handle each Server Events and illustrate use-cases on why they’d want to as it’s unusual for external consumers to be handling Server Events, which is normally tightly-coupled around the feature you want to provide real-time notifications for.

1 Like