mirror of
https://github.com/zap-proto/zip.git
synced 2026-10-19 15:38:57 +00:00
zeekayandHanzo Dev
5f71d2496b
App, Group, Operation. A group is a prefix and what holds under it, an operation
is one typed route declared there, and the verb methods are generic methods —
which Go 1.27 allows on a concrete type and still refuses on an interface. So In
and Out come from the handler and the caller writes no type arguments:
users := app.Group("/v1/users")
users.Post("/", api.Create)
mint := users.Group("/mint").With(middleware.Mint(gate))
mint.Post("/deposit", api.Deposit)
A Group is a CLOSED HANDLE: two unexported fields, and no method that hands back
the app, the parent or the fiber underneath. A subsystem given the group at its
own prefix cannot reach above it, so confinement is a property of the type
instead of a rule something has to police — which is what a host needs in order
to hand out a bounded surface and know what comes back.
That is bought by giving up the router interface, deliberately. Router and
OpTarget are gone, and with them the ability to implement a route table outside
this package: a decorator is no longer a router, a gate is middleware on a group,
and a bound is a path. The five package-level verb functions go the same way —
a registration is a method on the thing it registers into.
Raw carries what is not a typed operation: a stream, an upgrade, a probe, a
foreign subtree. It names its method, and it is the longer spelling because
opting out of the typed model is the exception and should read like one.
Co-authored-by: Hanzo Dev <[email protected]>
29 lines
665 B
Go
29 lines
665 B
Go
// Package badexample compiles fine and documents itself wrongly: its Example is
|
|
// not JSON. Generation has to fail on it, because the alternative is a spec that
|
|
// ships an example nobody can send.
|
|
package badexample
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/zap-proto/zip"
|
|
)
|
|
|
|
// In is the request.
|
|
type In struct {
|
|
Name string `json:"name"`
|
|
}
|
|
|
|
// Out is the response.
|
|
type Out struct {
|
|
OK bool `json:"ok"`
|
|
}
|
|
|
|
// Register wires the one broken operation.
|
|
func Register(app *zip.App) { app.Post("/v1/things", Create) }
|
|
|
|
// Create makes a thing.
|
|
//
|
|
// Example: {"name": "ada",}
|
|
func Create(_ context.Context, in *In) (*Out, error) { return &Out{OK: in.Name != ""}, nil }
|