rest

Documentation

Index

• Constants
• func BindBody(c echo.Context, i interface{}) error
• func CopyJsonBody(r *http.Request, i interface{}) error
• func FindUploadedFiles(r *http.Request, key string) ([]*filesystem.File, error)
• func NormalizeUrl(originalUrl string) (string, error)
• type Serializer
  • func (s *Serializer) Serialize(c echo.Context, i any, indent string) error

Constants

const DefaultMaxMemory = 32 << 20 // 32mb

DefaultMaxMemory defines the default max memory bytes that will be used when parsing a form request body.

Functions

func BindBody

func BindBody(c echo.Context, i interface{}) error

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

func CopyJsonBody(r *http.Request, i interface{}) error

CopyJsonBody reads the request body into i by creating a copy of `r.Body` to allow multiple reads.

func FindUploadedFiles

func FindUploadedFiles(r *http.Request, key string) ([]*filesystem.File, error)

FindUploadedFiles extracts all form files of "key" from a http request and returns a slice with filesystem.File instances (if any).

func NormalizeUrl

func NormalizeUrl(originalUrl string) (string, error)

NormalizeUrl removes duplicated slashes from a url path.

Types

type Serializer

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

func (s *Serializer) Serialize(c echo.Context, i any, indent string) error

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").