controller

Documentation

Index

• type HTTP
• type VersionedHTTP
• type ViewData
  • func NewViewData[T any](data any) ViewData

Types

type HTTP

type HTTP interface {
	// SetRoutes allocates routes into the given echo.Echo instance.
	SetRoutes(e *echo.Echo)
}

HTTP is the interface for controllers based on the HTTP protocol.

type VersionedHTTP

type VersionedHTTP interface {
	HTTP
	// SetVersionedRoutes registers routes in paths with a versioning prefix (e.g., /v1/foo, /v10/bar)
	SetVersionedRoutes(g *echo.Group)
}

VersionedHTTP is an extension of HTTP interface. It allows controllers to register routes in paths with a versioning prefix (e.g., /v1/foo, /v10/bar).

type ViewData

type ViewData struct {
	Data map[string]any `json:"data"`
}

ViewData is a general-purposed container for views to wrap themselves in a data field.

Useful in HTTP APIs for response standardization.

func NewViewData

func NewViewData[T any](data any) ViewData

NewViewData allocates a new ViewData instance. Uses T's type name as the key of the single entry for ViewData.Data map.