Support for Server-Sent-Events

[tobiaskahl]

If the Backend provides an API with Content-Type "application/stream+json" or "text/event-stream" swagger-ui should use an EventSource instead of sending ajax http-requests.

code:
var evtSource = new EventSource('http:server.domain.com/context_path)');
evtSource.onerror = function(e) {
console.log(e.data);
}
evtSource.onmessage = function(event) {
console.log(event.data);
}

instead of logging the data it should be displayed in the response field.

For IE-Support maybe it is necessary to include an polyfill.
e.g.: eventsource.js from https://github.com/Yaffle/EventSource/

[oscarnalin]

This is a great suggestion! Any chance it can be considered?

[sleepo581]

+1 Would be nice if swagger ui could support this

[ikosin]

This should be a part of #10575 (OpenAPI 3.2 support).

OpenAPI 3.2 spec includes support for text/event-stream and Server-Sent Events.

See: https://spec.openapis.org/oas/v3.2.0.html#special-considerations-for-server-sent-events