echokit

Documentation

Index

• func DumpEcho(e *echo.Echo) []string
• func HTTPError(err error) *echo.HTTPError
• func NewValidErr(message string) *echo.HTTPError
• func SetRoute(server Server, routers ...Router)
• type ResponseWriter
  • func NewResponseWriter() *ResponseWriter
  • func (w *ResponseWriter) CopyTo(rw http.ResponseWriter)
  • func (w *ResponseWriter) Header() http.Header
  • func (w *ResponseWriter) Write(b []byte) (int, error)
  • func (w *ResponseWriter) WriteHeader(statusCode int)
• type Router
  • func NewRouter(fn SetRouteFn) Router
• type Server
• type SetRouteFn

Functions

func DumpEcho

func DumpEcho(e *echo.Echo) []string

DumpEcho dump route in echo server

func HTTPError

func HTTPError(err error) *echo.HTTPError

HTTPError convert error to *echo.HTTPError

func NewValidErr

func NewValidErr(message string) *echo.HTTPError

NewValidErr create ValidationError

func SetRoute

func SetRoute(server Server, routers ...Router)

SetRoute to server

Types

type ResponseWriter

type ResponseWriter struct {
	Bytes      []byte
	StatusCode int
	RespHeader http.Header
}

ResponseWriter http response writer

func NewResponseWriter

func NewResponseWriter() *ResponseWriter

NewResponseWriter return new instance of ResponseWriter

func (*ResponseWriter) CopyTo

func (w *ResponseWriter) CopyTo(rw http.ResponseWriter)

CopyTo copy to another response writer

func (*ResponseWriter) Header

func (w *ResponseWriter) Header() http.Header

Header return http header

func (*ResponseWriter) Write

func (w *ResponseWriter) Write(b []byte) (int, error)

func (*ResponseWriter) WriteHeader

func (w *ResponseWriter) WriteHeader(statusCode int)

WriteHeader sends an HTTP response header with the provided status code

type Router

type Router interface {
	SetRoute(Server)
}

Router responsible to route

func NewRouter

func NewRouter(fn SetRouteFn) Router

NewRouter return new instance of Router

type Server

type Server interface {
	CONNECT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	DELETE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	GET(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	HEAD(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	OPTIONS(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	PATCH(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	POST(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	PUT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	TRACE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	Any(path string, handler echo.HandlerFunc, middleware ...echo.MiddlewareFunc) []*echo.Route
	Add(method, path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	Match(methods []string, path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) []*echo.Route
	Group(prefix string, m ...echo.MiddlewareFunc) *echo.Group
	Use(m ...echo.MiddlewareFunc)
}

Server interface for echo.Echo and echo.Group

type SetRouteFn

type SetRouteFn func(Server)

SetRouteFn function SetRoute