Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

opm

package module

Go to main page

Versions in this module

v1

v1.0.0

Jan 31, 2023

v0

v0.0.4

Nov 30, 2022

v0.0.3

Nov 30, 2022

Changes in this version

+ type Core struct

+ Logger Logger

+ MethodNotAllowedHandler Handler

+ NotFoundHandler Handler

+ Renderer Renderer

+ SystemErrorHandler Handler

+ func Make() *Core

+ func (core *Core) Any(path string, h Handler, m ...MiddlewareFunc) []*Route

+ func (core *Core) CONNECT(path string, h Handler, m ...MiddlewareFunc) *Route

+ func (core *Core) DELETE(path string, h Handler, m ...MiddlewareFunc) *Route

+ func (core *Core) DefaultHTTPErrorHandler(err error, c Context)

+ func (core *Core) File(path, file string)

+ func (core *Core) GET(path string, h Handler, m ...MiddlewareFunc) *Route

+ func (core *Core) Group(prefix string, m ...MiddlewareFunc) *Group

+ func (core *Core) HEAD(path string, h Handler, m ...MiddlewareFunc) *Route

+ func (core *Core) Match(req *http.Request, match *RouteMatch) bool

+ func (core *Core) Middleware(m ...MiddlewareFunc) *Group

+ func (core *Core) Name(name string) *Route

+ func (core *Core) NewContext(w http.ResponseWriter, req *http.Request) Context

+ func (core *Core) NewRoute() *Route

+ func (core *Core) OPTIONS(path string, h Handler, m ...MiddlewareFunc) *Route

+ func (core *Core) PATCH(path string, h Handler, m ...MiddlewareFunc) *Route

+ func (core *Core) POST(path string, h Handler, m ...MiddlewareFunc) *Route

+ func (core *Core) PUT(path string, h Handler, m ...MiddlewareFunc) *Route

+ func (core *Core) Path(path string) *Route

+ func (core *Core) Prefix(prefix string) *Group

+ func (core *Core) Run(addr string)

+ func (core *Core) RunServer(s *Server)

+ func (core *Core) ServeHTTP(w http.ResponseWriter, rq *http.Request)

+ func (core *Core) SetLog(logger Logger) *Core

+ func (core *Core) Static(path, root string) *Route

+ func (core *Core) TRACE(path string, h Handler, m ...MiddlewareFunc) *Route

+ func (core *Core) Use(m ...MiddlewareFunc)

+ type RouteList []*Route

+ type RouteNames map[string]*Route

v0.0.2

Jul 8, 2022

Changes in this version

+ const MIMEApplicationForm

+ const MIMEApplicationJSON

+ const MIMEApplicationJSONCharsetUTF8

+ const MIMEApplicationJavaScript

+ const MIMEApplicationJavaScriptCharsetUTF8

+ const MIMEMultipartForm

+ const MIMEOctetStream

+ const MIMETextHTML

+ const MIMETextHTMLCharsetUTF8

+ const MIMETextPlain

+ const MIMETextPlainCharsetUTF8

+ func InArrayString(arr []string, in string) bool

+ func StrConcat(ss ...string) string

+ func Xor(a, b []byte) []byte

type Group

+ func (g *Group) File(path, file string)

+ func (g *Group) Routes(f func(*Group) *Group) *Group

v0.0.1

Nov 19, 2021

Changes in this version

+ const DefaultHost

+ const DefaultPort

+ const ReadTimeout

+ const WriteTimeout

+ var ErrBadGateway = NewHTTPError(http.StatusBadGateway)

+ var ErrBadRequest = NewHTTPError(http.StatusBadRequest)

+ var ErrCookieNotFound = errors.New("cookie not found")

+ var ErrForbidden = NewHTTPError(http.StatusForbidden)

+ var ErrInternalServerError = NewHTTPError(http.StatusInternalServerError)

+ var ErrInvalidCertOrKeyType = errors.New("invalid cert or key type, must be string or []byte")

+ var ErrInvalidListenerNetwork = errors.New("invalid listener network")

+ var ErrInvalidRedirectCode = errors.New("invalid redirect status code")

+ var ErrMethodNotAllowed = NewHTTPError(http.StatusMethodNotAllowed)

+ var ErrNotFound = NewHTTPError(http.StatusNotFound)

+ var ErrRendererNotRegistered = errors.New("renderer not registered")

+ var ErrRequestTimeout = NewHTTPError(http.StatusRequestTimeout)

+ var ErrServiceUnavailable = NewHTTPError(http.StatusServiceUnavailable)

+ var ErrStatusRequestEntityTooLarge = NewHTTPError(http.StatusRequestEntityTooLarge)

+ var ErrTooManyRequests = NewHTTPError(http.StatusTooManyRequests)

+ var ErrUnauthorized = NewHTTPError(http.StatusUnauthorized)

+ var ErrUnsupportedMediaType = NewHTTPError(http.StatusUnsupportedMediaType)

+ var ErrValidatorNotRegistered = errors.New("validator not registered")

+ var HeaderAccept = "Accept"

+ var HeaderAcceptEncoding = "Accept-Encoding"

+ var HeaderAllow = "Allow"

+ var HeaderAuthorization = "Authorization"

+ var HeaderContentDisposition = "Content-Disposition"

+ var HeaderContentEncoding = "Content-Encoding"

+ var HeaderContentLength = "Content-Length"

+ var HeaderContentType = "Content-Type"

+ var HeaderCookie = "Cookie"

+ var HeaderIfModifiedSince = "If-Modified-Since"

+ var HeaderLastModified = "Last-Modified"

+ var HeaderLocation = "Location"

+ var HeaderOrigin = "Origin"

+ var HeaderServer = "Server"

+ var HeaderSetCookie = "Set-Cookie"

+ var HeaderUpgrade = "Upgrade"

+ var HeaderVary = "Vary"

+ var HeaderWWWAuthenticate = "WWW-Authenticate"

+ var HeaderXForwardedFor = "X-Forwarded-For"

+ var HeaderXForwardedProto = "X-Forwarded-Proto"

+ var HeaderXForwardedProtocol = "X-Forwarded-Protocol"

+ var HeaderXForwardedSsl = "X-Forwarded-Ssl"

+ var HeaderXHTTPMethodOverride = "X-HTTP-Method-Override"

+ var HeaderXRealIP = "X-Real-IP"

+ var HeaderXRequestID = "X-Request-ID"

+ var HeaderXRequestedWith = "X-Requested-With"

+ var HeaderXUrlScheme = "X-Url-Scheme"

+ func Contains(vals []string, s string) bool

+ func GenerateRandBytes(n int) ([]byte, error)

+ func NumFormat(v interface{}) string

+ func Strcon(ss ...string) string

+ func XorBytes(a, b []byte) []byte

+ type Context interface

+ Blob func(code int, contentType string, b []byte) (err error)

+ Body func() map[string]interface{}

+ Cookie func(name string) (*http.Cookie, error)

+ Cookies func() []*http.Cookie

+ Decode func(interface{}) error

+ Domain func() string

+ File func(file string) error

+ FormFile func(name string) (*multipart.FileHeader, error)

+ FormValue func(name string) string

+ Get func(key string) interface{}

+ GetValue func(string) interface{}

+ GetValues func() map[string]interface{}

+ HTML func(code int, html string) (err error)

+ HTMLBlob func(code int, b []byte) (err error)

+ JSON func(code int, data interface{}) error

+ Logger func() Logger

+ NoContent func(code int) error

+ Param func(name string) string

+ ParamNames func() []string

+ ParamValues func() []string

+ QueryParam func(name string) string

+ QueryParams func() url.Values

+ QueryString func() string

+ RealIP func() string

+ Redirect func(code int, url string) error

+ Render func(code int, filename string) error

+ Renderer func() Renderer

+ Request func() *http.Request

+ Reset func(w http.ResponseWriter, r *http.Request)

+ Response func() http.ResponseWriter

+ Route func() *Route

+ Set func(key string, val interface{})

+ SetCookie func(cookie *http.Cookie)

+ SetLogger func(l Logger)

+ SetParamNames func(names ...string)

+ SetParamValues func(values ...string)

+ SetRenderer func(Renderer)

+ SetRequest func(*http.Request)

+ SetResponse func(http.ResponseWriter)

+ SetRoute func(*Route)

+ SetValue func(string, interface{})

+ Stream func(code int, contentType string, r io.Reader) error

+ String func(code int, data string) error

+ type Group struct

+ func (g *Group) Add(method, path string, h Handler, m ...MiddlewareFunc) *Route

+ func (g *Group) Any(path string, h Handler, m ...MiddlewareFunc) []*Route

+ func (g *Group) CONNECT(path string, h Handler, m ...MiddlewareFunc) *Route

+ func (g *Group) DELETE(path string, h Handler, m ...MiddlewareFunc) *Route

+ func (g *Group) GET(path string, h Handler, m ...MiddlewareFunc) *Route

+ func (g *Group) Group(prefix string, middlewares ...MiddlewareFunc) *Group

+ func (g *Group) HEAD(path string, h Handler, m ...MiddlewareFunc) *Route

+ func (g *Group) OPTIONS(path string, h Handler, m ...MiddlewareFunc) *Route

+ func (g *Group) PATCH(path string, h Handler, m ...MiddlewareFunc) *Route

+ func (g *Group) POST(path string, h Handler, m ...MiddlewareFunc) *Route

+ func (g *Group) PUT(path string, h Handler, m ...MiddlewareFunc) *Route

+ func (g *Group) Path(path string) *Route

+ func (g *Group) Prefix(prefix string) *Group

+ func (g *Group) TRACE(path string, h Handler, m ...MiddlewareFunc) *Route

+ type HTTPError struct

+ Code int

+ Message interface{}

+ func NewHTTPError(code int, message ...interface{}) *HTTPError

+ func (e *HTTPError) Error() string

+ type Handler interface

+ Run func(Context) error

+ type HandlerFunc func(Context) error

+ func (f HandlerFunc) Run(c Context) error

+ type Logger interface

+ Debugf func(format string, args ...interface{})

+ Error func(i ...interface{})

+ Errorf func(format string, args ...interface{})

+ Fatal func(i ...interface{})

+ Fatalf func(format string, args ...interface{})

+ Info func(i ...interface{})

+ Infof func(format string, args ...interface{})

+ Panic func(i ...interface{})

+ Panicf func(format string, args ...interface{})

+ Warn func(i ...interface{})

+ Warnf func(format string, args ...interface{})

+ type Map map[string]interface

+ type MiddlewareFunc func(Handler) Handler

+ type Renderer interface

+ Render func(io.Writer, string, interface{}) error

+ type Route struct

+ func (r *Route) GetName() string

+ func (r *Route) GetPath() string

+ func (r *Route) Handler(handler Handler) *Route

+ func (r *Route) HandlerFunc(f func(Context) error) *Route

+ func (r *Route) Method(method string) *Route

+ func (r *Route) Name(name string) *Route

+ func (r *Route) Path(path string) *Route

+ func (r *Route) Use(m ...MiddlewareFunc) *Route

+ type RouteMatch struct

+ Handler Handler

+ MatchErr error

+ PNames []string

+ PValues []string

+ Route *Route

+ type Router struct

+ Logger Logger

+ MethodNotAllowedHandler Handler

+ NotFoundHandler Handler

+ Renderer Renderer

+ SystemErrorHandler Handler

+ func NewRouter() *Router

+ func (r *Router) Any(path string, h Handler, m ...MiddlewareFunc) []*Route

+ func (r *Router) CONNECT(path string, h Handler, m ...MiddlewareFunc) *Route

+ func (r *Router) DELETE(path string, h Handler, m ...MiddlewareFunc) *Route

+ func (r *Router) DefaultHTTPErrorHandler(err error, c Context)

+ func (r *Router) File(path, file string)

+ func (r *Router) GET(path string, h Handler, m ...MiddlewareFunc) *Route

+ func (r *Router) Group(prefix string, m ...MiddlewareFunc) *Group

+ func (r *Router) HEAD(path string, h Handler, m ...MiddlewareFunc) *Route

+ func (r *Router) Match(req *http.Request, match *RouteMatch) bool

+ func (r *Router) Middleware(m ...MiddlewareFunc) *Group

+ func (r *Router) Name(name string) *Route

+ func (r *Router) NewContext(w http.ResponseWriter, req *http.Request) Context

+ func (r *Router) NewRoute() *Route

+ func (r *Router) OPTIONS(path string, h Handler, m ...MiddlewareFunc) *Route

+ func (r *Router) PATCH(path string, h Handler, m ...MiddlewareFunc) *Route

+ func (r *Router) POST(path string, h Handler, m ...MiddlewareFunc) *Route

+ func (r *Router) PUT(path string, h Handler, m ...MiddlewareFunc) *Route

+ func (r *Router) Path(path string) *Route

+ func (r *Router) Prefix(prefix string) *Group

+ func (r *Router) ServeHTTP(w http.ResponseWriter, rq *http.Request)

+ func (r *Router) SetLog(logger Logger) *Router

+ func (r *Router) Static(path, root string) *Route

+ func (r *Router) TRACE(path string, h Handler, m ...MiddlewareFunc) *Route

+ func (r *Router) Use(m ...MiddlewareFunc)

+ type Server struct

+ Addr string

+ Handler http.Handler

+ Host string

+ Name string

+ Port int

+ ReadTimeout time.Duration

+ WriteTimeout time.Duration

+ func (s *Server) Run()