mirror of
https://github.com/hanzoai/zip.git
synced 2026-10-30 20:11:40 +00:00
zeekay
795617c313
The import path a reader types is the one the org owns, rather than the forge that happens to host the bytes. hanzo.ai serves the go-import meta and points it at the same repository, so where the code lives does not change. The README's `go get` line moves with it — an install instruction naming the old path is the one leftover a reader would actually follow.
57 lines
1.4 KiB
Go
57 lines
1.4 KiB
Go
// zap-typed example — typed handler with auto-generated OpenAPI spec.
|
|
//
|
|
// go run ./examples/zap-typed
|
|
// curl -X POST http://localhost:8080/v1/validate \
|
|
// -H 'Content-Type: application/json' \
|
|
// -d '{"email":"[email protected]","age":30}'
|
|
// curl http://localhost:8080/.well-known/openapi.json | jq
|
|
// open http://localhost:8080/docs
|
|
package main
|
|
|
|
import (
|
|
"context"
|
|
"log"
|
|
"strings"
|
|
|
|
"hanzo.ai/zip"
|
|
)
|
|
|
|
// ValidateRequest is the input type. zip derives an OpenAPI schema
|
|
// from these struct tags.
|
|
type ValidateRequest struct {
|
|
Email string `json:"email" validate:"required,minlen=3,maxlen=255"`
|
|
Age int `json:"age" validate:"required,min=18,max=120"`
|
|
}
|
|
|
|
// ValidateResponse is the output type. Same auto-schema derivation.
|
|
type ValidateResponse struct {
|
|
OK bool `json:"ok"`
|
|
Normalized string `json:"normalized"`
|
|
}
|
|
|
|
func main() {
|
|
app := zip.New(zip.Config{
|
|
AppName: "zap-typed",
|
|
OpenAPI: zip.OpenAPIConfig{
|
|
Title: "Validate API",
|
|
Description: "Example of zip's typed handler + auto-OpenAPI",
|
|
Version: "v0.1.0",
|
|
},
|
|
})
|
|
|
|
zip.Post(app, "/v1/validate", validate,
|
|
zip.WithSummary("Validate an email and age"),
|
|
zip.WithTags("validation"),
|
|
)
|
|
|
|
log.Fatal(app.Listen(":8080"))
|
|
}
|
|
|
|
func validate(ctx context.Context, in *ValidateRequest) (*ValidateResponse, error) {
|
|
_ = ctx
|
|
return &ValidateResponse{
|
|
OK: true,
|
|
Normalized: strings.ToLower(in.Email),
|
|
}, nil
|
|
}
|