mirror of
https://github.com/zap-proto/zip.git
synced 2026-10-19 15:38:57 +00:00
zeekayandHanzo Dev
bbabddeaa8
Ten of eleven examples declared their surface with untyped handlers. An untyped route registers no op, so every one of them modelled the single pattern that leaves an endpoint out of the OpenAPI document, out of the MCP tool list, out of the CLI and out of the call plane — while the README two files away calls that registry the one source of truth. The examples are where the default is learned, and they were teaching the wrong one. hello, subsystem-mount, migrate-from-chi, migrate-from-beego, plugin/billing, plugin/host and internal/testplugin now declare typed ops. The migrate-from-* examples show the port as the two steps it is: mechanical first (same handler shape, one edit, and invisible to every projection), typed second, because stopping after the first leaves exactly the surface you were migrating away from. sse-streaming and websocket stay untyped and now say why in the file header: a typed op is one decode, one call, one serialize, and a stream has no single value to return while an upgrade has no response body at all. That is the whole list of reasons — a stream, an upgrade, a proxied byte range, a non-JSON body. express-in-zip registered two routes on app.Fiber(), BELOW zip entirely: no *zip.Ctx, no error handler, no middleware, no Authorizer, and no projection — served by the app but not governed by it, which is a security seam and not a shortcut. Both move onto the zip router. /runtime/:lang becomes a typed op, so "run this source in this language" is now in the document and is a tool an agent can call; the legacy JS wildcard stays a wildcard and says what that costs. testplugin's catch-all stays untyped for the reason it exists: it answers paths that do not exist, so a host mounting it at two prefixes can tell its own 404 from the plugin's. A wildcard is deliberately not one named endpoint with one schema. Every example was run and probed, not just built: 30 assertions across all eleven, including the openapi/mcp routes the typed ops now light up. Co-authored-by: Hanzo Dev <[email protected]>
52 lines
1.6 KiB
Go
52 lines
1.6 KiB
Go
// sse-streaming example — Server-Sent Events via c.SendStreamWriter.
|
|
// LLM-gateway pattern: stream tokens as they arrive from upstream.
|
|
//
|
|
// go run ./examples/sse-streaming
|
|
// curl -N http://localhost:8080/v1/stream
|
|
//
|
|
// # Untyped on purpose — one of the few places it is right
|
|
//
|
|
// A typed op is (In → Out): zip decodes the input, runs the handler ONCE, and
|
|
// serializes the single value it returns. This route has no single value to
|
|
// return. It holds the connection open and writes frames as they arrive, which
|
|
// is what SSE IS, so there is nothing for a response schema to describe and
|
|
// nothing an MCP tools/call could hand back.
|
|
//
|
|
// The cost is real and worth stating: this route is in no OpenAPI document, is
|
|
// no MCP tool, and no service can reach it with zip.Call. Everything that CAN
|
|
// name its output should be a typed op — see examples/hello. Reach for an
|
|
// untyped handler when the response is a stream, an upgrade, a proxied byte
|
|
// range or a non-JSON body, and for nothing else.
|
|
package main
|
|
|
|
import (
|
|
"bufio"
|
|
"fmt"
|
|
"log"
|
|
"time"
|
|
|
|
"github.com/zap-proto/zip"
|
|
)
|
|
|
|
func main() {
|
|
app := zip.New(zip.Config{AppName: "sse-streaming"})
|
|
|
|
app.Get("/v1/stream", func(c *zip.Ctx) error {
|
|
c.SetHeader("Content-Type", "text/event-stream")
|
|
c.SetHeader("Cache-Control", "no-cache")
|
|
c.SetHeader("Connection", "keep-alive")
|
|
|
|
return c.SendStreamWriter(func(w *bufio.Writer) {
|
|
for i := 0; i < 10; i++ {
|
|
_, _ = fmt.Fprintf(w, "data: tick %d\n\n", i)
|
|
if err := w.Flush(); err != nil {
|
|
return
|
|
}
|
|
time.Sleep(200 * time.Millisecond)
|
|
}
|
|
})
|
|
})
|
|
|
|
log.Fatal(app.Listen("http://:8080"))
|
|
}
|