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]>
57 lines
1.6 KiB
Go
57 lines
1.6 KiB
Go
// Hello, zip — minimal example.
|
|
//
|
|
// go run ./examples/hello
|
|
// curl http://localhost:8080/hello
|
|
// curl http://localhost:8080/.well-known/openapi.json # the same two ops
|
|
// curl -XPOST -d '{"method":"tools/list"}' http://localhost:8080/mcp
|
|
//
|
|
// Both routes are TYPED ops, which is the default. zip.Get[In, Out] registers
|
|
// ONE operation, and zip projects it into the REST route, the OpenAPI document,
|
|
// an MCP tool, a `<service> <operation>` command line and a by-name call plane.
|
|
// An untyped app.Get(path, func(c *zip.Ctx) error) registers no operation and
|
|
// therefore appears in NONE of them — see examples/sse-streaming for the case
|
|
// where that is still the right trade.
|
|
package main
|
|
|
|
import (
|
|
"context"
|
|
"log"
|
|
|
|
"github.com/zap-proto/zip"
|
|
"github.com/zap-proto/zip/middleware"
|
|
)
|
|
|
|
// Greeting is what GET /hello answers.
|
|
type Greeting struct {
|
|
Message string `json:"message"`
|
|
}
|
|
|
|
// Health is what GET /health answers.
|
|
type Health struct {
|
|
Status string `json:"status"`
|
|
}
|
|
|
|
// Empty is an operation that takes nothing. A GET binds its input from the URL,
|
|
// and these two read no part of it.
|
|
type Empty struct{}
|
|
|
|
func main() {
|
|
app := zip.New(zip.Config{AppName: "hello"})
|
|
app.Use(middleware.Recover(), middleware.RequestID())
|
|
|
|
zip.Get(app, "/hello", hello)
|
|
zip.Get(app, "/health", health)
|
|
|
|
log.Fatal(app.Listen("http://:8080"))
|
|
}
|
|
|
|
// Hello greets the caller.
|
|
func hello(_ context.Context, _ *Empty) (*Greeting, error) {
|
|
return &Greeting{Message: "hello world"}, nil
|
|
}
|
|
|
|
// Health reports whether the service is up.
|
|
func health(_ context.Context, _ *Empty) (*Health, error) {
|
|
return &Health{Status: "ok"}, nil
|
|
}
|