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

rest

package

Go to main page

Versions in this module

v1

v1.3.3

Apr 18, 2022

Changes in this version

type RouteOption

+ func WithMaxBytes(maxBytes int64) RouteOption

v1.2.9

Feb 23, 2022

v1.2.8

Feb 23, 2022

v1.2.7

Jan 20, 2022

Changes in this version

+ var ErrSignatureConfig = errors.New("bad config for Signature")

+ type Middleware func(next http.HandlerFunc) http.HandlerFunc

+ func ToMiddleware(handler func(next http.Handler) http.Handler) Middleware

+ type PrivateKeyConf struct

+ Fingerprint string

+ KeyFile string

+ type RestConf struct

+ CertFile string

+ CpuThreshold int64

+ Host string

+ KeyFile string

+ MaxBytes int64

+ MaxConns int

+ Port int

+ Signature SignatureConf

+ Timeout int64

+ Verbose bool

+ type Route struct

+ Handler http.HandlerFunc

+ Method string

+ Path string

+ func WithMiddleware(middleware Middleware, rs ...Route) []Route

+ func WithMiddlewares(ms []Middleware, rs ...Route) []Route

+ type RouteOption func(r *featuredRoutes)

+ func WithJwt(secret string) RouteOption

+ func WithJwtTransition(secret, prevSecret string) RouteOption

+ func WithPrefix(group string) RouteOption

+ func WithPriority() RouteOption

+ func WithSignature(signature SignatureConf) RouteOption

+ func WithTimeout(timeout time.Duration) RouteOption

+ type RunOption func(*Server)

+ func WithCors(origin ...string) RunOption

+ func WithCustomCors(middlewareFn func(header http.Header), notAllowedFn func(http.ResponseWriter), ...) RunOption

+ func WithNotAllowedHandler(handler http.Handler) RunOption

+ func WithNotFoundHandler(handler http.Handler) RunOption

+ func WithRouter(router httpx.Router) RunOption

+ func WithTLSConfig(cfg *tls.Config) RunOption

+ func WithUnauthorizedCallback(callback handler.UnauthorizedCallback) RunOption

+ func WithUnsignedCallback(callback handler.UnsignedCallback) RunOption

+ type Server struct

+ func MustNewServer(c RestConf, opts ...RunOption) *Server

+ func NewServer(c RestConf, opts ...RunOption) (*Server, error)

+ func (s *Server) AddRoute(r Route, opts ...RouteOption)

+ func (s *Server) AddRoutes(rs []Route, opts ...RouteOption)

+ func (s *Server) Start()

+ func (s *Server) Stop()

+ func (s *Server) Use(middleware Middleware)

+ type SignatureConf struct

+ Expiry time.Duration

+ PrivateKeys []PrivateKeyConf

+ Strict bool