Documentation
¶
Index ¶
- Constants
- func BindBody(c echo.Context, i any) error
- func CopyJsonBody(r *http.Request, i any) error
- func FindUploadedFiles(r *http.Request, key string) ([]*filesystem.File, error)
- func NormalizeUrl(originalUrl string) (string, error)
- func PickFields(data any, rawFields string) (any, error)
- type FieldModifier
- type MultiBinder
- type Serializer
Constants ¶
const DefaultMaxMemory = 32 << 20 // 32mb
DefaultMaxMemory defines the default max memory bytes that will be used when parsing a form request body.
const MultipartJsonKey string = "@jsonPayload"
MultipartJsonKey is the key for the special multipart/form-data handling allowing reading serialized json payload without normalization.
Variables ¶
This section is empty.
Functions ¶
func BindBody ¶
BindBody binds request body content to i.
This is similar to `echo.BindBody()`, but for JSON requests uses custom json reader that **copies** the request body, allowing multiple reads.
func CopyJsonBody ¶ added in v0.8.0
CopyJsonBody reads the request body into i by creating a copy of `r.Body` to allow multiple reads.
func FindUploadedFiles ¶
FindUploadedFiles extracts all form files of "key" from a http request and returns a slice with filesystem.File instances (if any).
func NormalizeUrl ¶ added in v0.5.0
NormalizeUrl removes duplicated slashes from a url path.
func PickFields ¶ added in v0.20.0
PickFields parses the provided fields string expression and returns a new subset of data with only the requested fields.
Fields transformations with modifiers are also supported (see initModifer()).
Example:
data := map[string]any{"a": 1, "b": 2, "c": map[string]any{"c1": 11, "c2": 22}}
PickFields(data, "a,c.c1") // map[string]any{"a": 1, "c": map[string]any{"c1": 11}}
Types ¶
type FieldModifier ¶ added in v0.19.0
type MultiBinder ¶ added in v0.21.0
type MultiBinder struct{}
MultiBinder is similar to echo.DefaultBinder but uses slightly different application/json and multipart/form-data bind methods to accommodate better the PocketBase router needs.
func (*MultiBinder) Bind ¶ added in v0.21.0
func (b *MultiBinder) Bind(c echo.Context, i interface{}) (err error)
Bind implements the [Binder.Bind] method.
Bind is almost identical to echo.DefaultBinder.Bind but uses the rest.BindBody function for binding the request body.
type Serializer ¶ added in v0.16.0
type Serializer struct {
echo.DefaultJSONSerializer
FieldsParam string
}
Serializer represents custom REST JSON serializer based on echo.DefaultJSONSerializer, with support for additional generic response data transformation (eg. fields picker).
func (*Serializer) Serialize ¶ added in v0.16.0
Serialize converts an interface into a json and writes it to the response.
It also provides a generic response data fields picker via the FieldsParam query parameter (default to "fields").
Note: for the places where it is safe, the std encoding/json is replaced with goccy due to its slightly better Unmarshal/Marshal performance.
Source Files