acacode / acacode/swagger-typescript-api

Support generating EventSource clients for text/event-stream endpoints

Offen
#1,819 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
TypeScript
Sterne
4.1k
Forks
436
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

OpenAPI explicitly supports text/event-stream as a response media type (See https://spec.openapis.org/oas/latest.html#media-types). Currently swagger-typescript-api generates these endpoints as a standard request(), where T is the schema of a single event payload. However, this is semantically incorrect because an SSE endpoint produces a sequence of events rather than a single response object.

Would you be interested in adding optional support for generating SSE-aware clients (for example returning EventSource, AsyncIterable, or via a configurable template) when the response media type is `text/event-stream`?

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.