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
- API
  
  Reference documentation for the pkg.go.dev API
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

api

package

Go to main page

Versions in this module

v1

v1.4.0

Aug 18, 2026

Changes in this version

+ const DefaultContentSecurityPolicy

+ func APIAuthenticationMiddleware(next http.Handler) http.Handler

+ func ConfigureAPIAuth(store *auth.Store, adminToken string)

+ func ConfigureItemFeatures(config ItemFeatureConfig)

+ func ConfigurePreviewCache(maxBytes int64)

+ func ConfigureWorkLimits(config WorkLimitConfig) error

+ func NewJSONAccessLogMiddleware(config AccessLogConfig, resolver *ClientIPResolver) func(http.Handler) http.Handler

+ func NewRateLimitMiddleware(limiter *RateLimiter, resolver *ClientIPResolver, config RateLimitConfig) func(http.Handler) http.Handler

+ func NewRequestIDMiddleware(config RequestIDConfig) func(http.Handler) http.Handler

+ func NewSecurityPolicyMiddleware(config SecurityHeadersConfig, resolver *ClientIPResolver) func(http.Handler) http.Handler

+ func PrincipalFromRequest(r *http.Request) (auth.Principal, bool)

+ func RequestIDFromContext(ctx context.Context) string

+ func SecurityHeadersMiddleware(next http.Handler) http.Handler

+ func WorkLimitStats() map[string]WorkLimitSnapshot

+ type AccessLogConfig struct

+ Clock func() time.Time

+ Enabled bool

+ Writer io.Writer

+ type ClientIPConfig struct

+ TrustForwardedHeaders bool

+ TrustedProxyCIDRs []string

+ type ClientIPResolver struct

+ func NewClientIPResolver(config ClientIPConfig) (*ClientIPResolver, error)

+ func (r *ClientIPResolver) ClientIP(request *http.Request) string

+ type HTTPMiddleware struct

+ func NewHTTPMiddleware(config HTTPMiddlewareConfig) (*HTTPMiddleware, error)

+ func (middleware *HTTPMiddleware) Close()

+ func (middleware *HTTPMiddleware) Wrap(next http.Handler) http.Handler

+ func (middleware *HTTPMiddleware) WrapWithAuthentication(next http.Handler, authentication func(http.Handler) http.Handler) http.Handler

+ type HTTPMiddlewareConfig struct

+ AccessLog AccessLogConfig

+ ClientIP ClientIPConfig

+ RateLimit RateLimitConfig

+ RequestID RequestIDConfig

+ SecurityHeaders SecurityHeadersConfig

+ func DefaultHTTPMiddlewareConfig() HTTPMiddlewareConfig

+ type ItemFeatureConfig struct

+ DefaultExpiry time.Duration

+ MaximumExpiry time.Duration

+ RequireTokenForCreate bool

+ type RateLimitConfig struct

+ AnonymousPerIP RateLimitPolicy

+ ApplyIPLimitToAuthenticated bool

+ AuthenticatedIdentity func(*http.Request) (string, bool)

+ AuthenticatedPerToken RateLimitPolicy

+ CleanupInterval time.Duration

+ CreatePaths []string

+ CreatePerIdentity RateLimitPolicy

+ EntryTTL time.Duration

+ MaxIPEntries int

+ MaxTokenEntries int

+ type RateLimitPolicy struct

+ Burst int

+ Requests int

+ Window time.Duration

+ type RateLimiter struct

+ func NewRateLimiter(config RateLimitConfig) (*RateLimiter, error)

+ func (l *RateLimiter) Allow(ipAddress, tokenIdentity string) (bool, time.Duration)

+ func (l *RateLimiter) Cleanup()

+ func (l *RateLimiter) Close()

+ func (l *RateLimiter) EntryCount() (int, int)

+ type RequestIDConfig struct

+ AcceptIncoming bool

+ Enabled bool

+ Generator func() string

+ Header string

+ type SecurityHeadersConfig struct

+ ContentSecurityPolicy string

+ Enabled bool

+ PermissionsPolicy string

+ ReferrerPolicy string

+ StrictTransportPolicy string

+ type WorkLimitConfig struct

+ DiffLimit int

+ FormatLimit int

+ PreviewLimit int

+ WaitTimeout time.Duration

+ func DefaultWorkLimitConfig() WorkLimitConfig

+ type WorkLimitSnapshot struct

+ Active int

+ Limit int

v1.3.1

May 12, 2026

v1.3.0

May 12, 2026

Changes in this version

+ func LoggingMiddleware(next http.Handler) http.Handler

+ func RegisterRoutes(mux *http.ServeMux)

+ type DiffRequest struct

+ Base string

+ Compare string

+ type DiffResponse struct

+ BaseLines []string

+ CompareLines []string

+ OpCodes []OpCodeInfo

+ type OpCodeInfo struct

+ I1 int

+ I2 int

+ J1 int

+ J2 int

+ Tag string