oapi-codegen · mromaszewicz · Apr 21, 2026 · Jan 15, 2022 · Sep 18, 2024 · Sep 18, 2024
@@ -192,6 +192,13 @@
             "type": "string"
           }
         },
+        "streaming-content-types": {
+          "type": "array",
+          "description": "Additional regex patterns matched against response Content-Type to decide when the strict server should generate a flush-per-chunk streaming response. Merged with the defaults (text/event-stream, application/jsonl, application/x-ndjson). Invalid regexes fail configuration validation.",
+          "items": {
+            "type": "string"
+          }
+        },
         "nullable-type": {
           "type": "boolean",
           "description": "Whether to generate nullable type for nullable fields"

@@ -0,0 +1,17 @@
+OpenAPI Code Generation Example - Streaming
+-------------------------------------------
+
+This directory contains an example server using our code generator which implements
+a simple streaming API with a single endpoint.
+
+This is the structure:
+- `sse.yaml`: Contains the OpenAPI 3.0 specification
+- `stdhttp/`: Contains the written and generated code for the server using the standard http package
+- `client/`: Contains a client which reads the server stream and prints out the messages
+
+You can run both together to demonstrate the end-to-end behavior from
+both client and server side. Run these commands in parallel:
+
+    go run ./stdhttp
+    go run ./client
+
@@ -0,0 +1,52 @@
+package main
+
+import (
+	"bufio"
+	"context"
+	"flag"
+	"fmt"
+	"log/slog"
+	"net/http"
+	"os"
+	"os/signal"
+	"syscall"
+
+	"github.com/oapi-codegen/oapi-codegen/v2/examples/streaming/client/sse"
+)
+
+func main() {
+	serverURL := flag.String("url", "http://localhost:8080", "server base URL")
+	flag.Parse()
+
+	ctx, cancel := signal.NotifyContext(context.Background(), syscall.SIGINT, syscall.SIGTERM)
+	defer cancel()
+
+	client, err := sse.NewClient(*serverURL)
+	if err != nil {
+		slog.Error("NewClient failed", "error", err)
+		os.Exit(1)
+	}
+
+	// Use the plain Client (not ClientWithResponses) so the response body stays
+	// an open io.Reader — ClientWithResponses would io.ReadAll the stream.
+	resp, err := client.GetStream(ctx)
+	if err != nil {
+		slog.Error("GetStream failed", "error", err)
+		os.Exit(1)
+	}
+	defer func() { _ = resp.Body.Close() }()
+
+	if resp.StatusCode != http.StatusOK {
+		slog.Error("unexpected status", "status", resp.Status)
+		os.Exit(1)
+	}
+
+	scanner := bufio.NewScanner(resp.Body)
+	for scanner.Scan() {
+		fmt.Println(scanner.Text())
+	}
+	if err := scanner.Err(); err != nil && ctx.Err() == nil {
+		slog.Error("scan failed", "error", err)
+		os.Exit(1)
+	}
+}
@@ -0,0 +1,6 @@
+# yaml-language-server: $schema=../../../../configuration-schema.json
+package: sse
+output: streaming.gen.go
+generate:
+  client: true
+  models: true
@@ -0,0 +1,3 @@
+package sse
+
+//go:generate go run github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen -config cfg.yaml ../../sse.yaml
@@ -0,0 +1,28 @@
+openapi: 3.0.0
+info:
+  title: Simple JSONL Streaming Service
+  version: 1.0.0
+paths:
+  /:
+    get:
+      summary: JSON Lines Stream
+      description: Provides a stream of JSON documents (one per line, application/jsonl) containing a timestamp and sequence number.
+      operationId: getStream
+      responses:
+        200:
+          description: JSONL Stream
+          content:
+            application/jsonl:
+              schema:
+                type: object
+                properties:
+                  time:
+                    type: string
+                    format: date-time
+                    description: Timestamp of the event.
+                  sequence:
+                    type: integer
+                    description: Sequence number of the event.
+              example:
+                time: "2023-11-20T10:30:00Z"
+                sequence: 1
@@ -0,0 +1,36 @@
+SHELL:=/bin/bash
+
+YELLOW := \e[0;33m
+RESET := \e[0;0m
+
+GOVER := $(shell go env GOVERSION)
+GOMINOR := $(shell bash -c "cut -f2 -d. <<< $(GOVER)")
+
+define execute-if-go-122
+@{ \
+if [[ 22 -le $(GOMINOR) ]]; then \
+	$1; \
+else \
+	echo -e "$(YELLOW)Skipping task as you're running Go v1.$(GOMINOR).x which is < Go 1.22, which this module requires$(RESET)"; \
+fi \
+}
+endef
+
+lint:
+	$(call execute-if-go-122,$(GOBIN)/golangci-lint run ./...)
+
+lint-ci:
+
+	$(call execute-if-go-122,$(GOBIN)/golangci-lint run ./... --out-format=colored-line-number --timeout=5m)
+
+generate:
+	$(call execute-if-go-122,go generate ./...)
+
+test:
+	$(call execute-if-go-122,go test -cover ./...)
+
+tidy:
+	$(call execute-if-go-122,go mod tidy)
+
+tidy-ci:
+	$(call execute-if-go-122,tidied -verbose)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		package sse

		//go:generate go run github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen -config cfg.yaml ../../sse.yaml