goh = Go HTTP Handlers.
Utility types that represent a not-yet-sent HTTP response as a value (status, header, body) with no added abstractions. All types implement http.Hander.
Recommended in conjunction with github.com/mitranim/rout: router with support for returning responses as http.Handler.
Small and dependency-free.
See API docs at https://pkg.go.dev/github.com/mitranim/goh.
import "github.com/mitranim/goh"
type Val struct {
One int64 `json:"one"`
Two int64 `json:"two"`
}
type ErrJson struct {
Error error `json:"error"`
}
// Simple string example.
func handler(req *http.Request) http.Handler {
return goh.StringOk(`response text`)
}
// String example with status and headers.
func handler(req *http.Request) http.Handler {
return goh.String{
Status: http.StatusCreated,
Header: http.Header{`Content-Type`: {`text/html`}},
Body: `<body>response text</body>`,
}
}
// Simple JSON example.
func handler(req *http.Request) http.Handler {
return goh.JsonOk(Val{10, 20})
}
// JSON example with custom error handler.
func handler(req *http.Request) http.Handler {
return goh.Json{
Body: Val{10, 20},
ErrFunc: writeErrAsJson,
}
}
// You can customize the default error handler.
func init() {
goh.HandleErr = writeErrAsJson
}
// Example custom error handler.
// Should be provided to response types as `ErrFunc: writeErrAsJson`.
func writeErrAsJson(
rew http.ResponseWriter, req *http.Request, err error, wrote bool,
) {
if err == nil {
return
}
if !wrote {
rew.WriteHeader(http.StatusInternalServerError)
err := json.NewEncoder(rew).Encode(ErrJson{err})
if err != nil {
fmt.Fprintf(os.Stderr, "secondary error while writing error response: %+v\n", err)
return
}
}
fmt.Fprintf(os.Stderr, "error while writing HTTP response: %+v\n", err)
}Breaking:
- Renamed
.MaybeHanto.HanOptin various types.
Added:
File.ServedHTTP.File.Exists.File.Existing.Dir.ServedHTTP.Dir.Resolve.Dir.Allow.Dir.File.HttpHandlerOpt(implemented byFileandDir).
Fixed:
Fileno longer writes its.Headerwhen the target file is not found.
Json and Xml now support pretty-printing via field .Indent.
Cosmetic renaming and minor cleanup. Renamed ErrHandlerDefault → HandleErr, ErrHandler → WriteErr, tweaked argument order in ErrFunc, tweaked default error handling in WriteErr, tweaked error messages.
Lexicon change: "Res" → "Han" for functions that return http.Handler.
Add TryJsonBytes.
Added file-serving facilities:
FileDirFilterFilterFuncAllowDors
This provides richer file-serving functionality than net/http, including the ability to serve paths from a folder selectively, or being able to "try file" and fall back on something else.
Json.TryBytes and Xml.TryBytes no longer panic on nil header.
Added Json.TryBytes and Xml.TryBytes for pre-encoding static responses.
Added .Res() methods for request → response signatures.
Added Err, Handler, Respond.
Redirect no longer writes the HTTP status before invoking http.Redirect.
Optional support for <?xml?>.
I'm receptive to suggestions. If this library almost satisfies you but needs changes, open an issue or chat me up. Contacts: https://mitranim.com/#contacts
