Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  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

httpserver

package module

Go to main page

Versions in this module

v0

v0.9.0

Mar 4, 2026

Changes in this version

type OptionsFunc

+ func WithAuthToken(headerName, secret string) OptionsFunc

+ func WithDefaultSecurityHeaders() OptionsFunc

type ServerConfig

+ ServerName string

v0.8.6

Feb 26, 2026

v0.8.5

Dec 15, 2025

v0.8.4

Nov 1, 2025

v0.8.3

Oct 8, 2025

Changes in this version

+ func NewFieldError(field string, message string) error

+ type FieldError struct

+ Err error

+ Field string

+ func (e *FieldError) Error() string

+ func (e *FieldError) Unwrap() error

+ type Validator interface

+ Validate func() error

v0.8.2

Sep 23, 2025

Changes in this version

type ServerConfig

+ TrustedProxies []string

+ func (c *ServerConfig) GetUrl() string

v0.8.1

Sep 15, 2025

v0.8.0

Sep 12, 2025

Changes in this version

+ const OptAuthTokenHeader

+ const OptAuthTokenSecret

+ const OptDefaultSecurityHeaders

+ const OptHMACSecret

+ const ServerDefaultName

+ const ServerDefaultPort

+ const ServerDefaultReadTimeout

+ const ServerDefaultWriteTimeout

+ func NewRouter(serverName string, debug bool, logger *log.Logger) *gin.Engine

+ func ValidateJSON(c *gin.Context, obj interface{}) bool

+ func ValidateQuery(c *gin.Context, obj interface{}) bool

+ type OptionsFunc func(*Server) error

+ type Server struct

+ Config *ServerConfig

+ Logger *log.Logger

+ Router *gin.Engine

+ Server *http.Server

+ func NewServer(cfg *ServerConfig, logger *log.Logger) (*Server, error)

+ func (s *Server) AddMiddleware(middlewareFunc gin.HandlerFunc)

+ func (s *Server) Group(relativePath string) *gin.RouterGroup

+ func (s *Server) ProcessOptions(withOptions ...OptionsFunc) error

+ func (s *Server) Route() *gin.Engine

+ func (s *Server) Shutdown(ctx context.Context) error

+ func (s *Server) Start() error

+ func (s *Server) UseAuth(provider auth.Provider)

+ func (s *Server) UseCSRFProtection()

+ func (s *Server) UseDefaultSecurityHeaders()

+ func (s *Server) UseRateLimiting(ratePerMinute int)

+ func (s *Server) UseSecurityHeaders(config *security.SecurityConfig)

+ func (s *Server) UseSession(config *session.Config, backend kv.KV, logger *log.Logger) (*session.Manager, error)

+ type ServerConfig struct

+ Debug bool

+ Host string

+ Options map[string]string

+ Port int

+ ReadTimeout int

+ WriteTimeout int

+ func NewServerConfig() *ServerConfig

+ func (c *ServerConfig) GetOption(key string, defaultValue string) string

+ func (c *ServerConfig) NewServer(logger *log.Logger) (*Server, error)

+ func (c *ServerConfig) Validate() error

+ type ValidationError struct

+ Field string

+ Message string

Other modules containing this package

github.com/oddbit-project/blueprint