Documentation
¶
Overview ¶
Package httphelpers provides shared HTTP handler prelude helpers used across server sub-packages. This breaks the import cycle between server/ and its sub-packages (queryhandlers, confighandlers, etc.) that previously required copy-pasting these helpers.
Index ¶
- Constants
- func DecodeJSONBody(w http.ResponseWriter, r *http.Request, dst any, maxBytes int64) bool
- func RequireGET(w http.ResponseWriter, r *http.Request) bool
- func RequireMethod(w http.ResponseWriter, r *http.Request, method string) bool
- func RequirePOST(w http.ResponseWriter, r *http.Request) bool
Constants ¶
const MaxDefaultBodySize = 1 << 20
MaxDefaultBodySize is the default JSON body size cap for most handlers (1 MiB).
Variables ¶
This section is empty.
Functions ¶
func DecodeJSONBody ¶
DecodeJSONBody decodes a JSON request body into dst with a size cap. Writes 400 and returns false on decode failure.
func RequireGET ¶
func RequireGET(w http.ResponseWriter, r *http.Request) bool
RequireGET is sugar for RequireMethod(w, r, http.MethodGet).
func RequireMethod ¶
RequireMethod checks that the request method matches the expected value. Writes 405 and returns false if not.
func RequirePOST ¶
func RequirePOST(w http.ResponseWriter, r *http.Request) bool
RequirePOST is sugar for RequireMethod(w, r, http.MethodPost).
Types ¶
This section is empty.