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.1.2

Jul 15, 2026

v1.1.1

Jul 15, 2026

v1.1.0

May 4, 2026

v1.0.1

May 2, 2026

v1.0.0

Mar 27, 2026

v0

v0.5.3

Mar 22, 2026

v0.5.2

Jan 16, 2026

v0.5.1

Jan 16, 2026

Changes in this version

+ const CarIDQueryParam

+ const DefaultResultsPerPage

+ const DriverIDPathParam

+ const EndTimeQueryParam

+ const GranularityQueryParam

+ const GroupByQueryParam

+ const PageQueryParam

+ const ResultsPerPageParam

+ const SeriesIDQueryParam

+ const StartTimeQueryParam

+ const TrackIDQueryParam

+ func AuthMiddleware(validator TokenValidator) func(next http.Handler) http.Handler

+ func DoAcceptedResponse(ctx context.Context, Response interface{}, writer http.ResponseWriter)

+ func DoBadRequestResponse(ctx context.Context, result RequestErrors, writer http.ResponseWriter)

+ func DoErrorResponse(ctx context.Context, writer http.ResponseWriter)

+ func DoForbiddenResponse(ctx context.Context, message string, writer http.ResponseWriter)

+ func DoNotFoundResponse(ctx context.Context, message string, writer http.ResponseWriter)

+ func DoOKListResponse[T any](ctx context.Context, items []T, page, resultsPerPage, totalResults int, ...)

+ func DoOKResponse(ctx context.Context, Response interface{}, writer http.ResponseWriter)

+ func DoTooManyRequestsResponse(ctx context.Context, message string, retryAfterSeconds int, ...)

+ func DoUnauthorizedResponse(ctx context.Context, message string, writer http.ResponseWriter)

+ func DriverOwnershipMiddleware(pathParam string) func(next http.Handler) http.Handler

+ func EntitlementMiddleware(requiredEntitlement string) func(next http.Handler) http.Handler

+ func NewRestAPI(logger zerolog.Logger, correlationIDGenerator correlation.IDGenerator, ...) http.Handler

+ func ReduceDeadlineMiddleware(buffer time.Duration) func(next http.Handler) http.Handler

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

+ func SensitiveClaimsFromContext(ctx context.Context) *auth.SensitiveClaims

+ func SessionClaimsFromContext(ctx context.Context) *auth.SessionClaims

+ func WrapWithSegment(segmentName string, handler http.Handler) http.Handler

+ func ZerologLogAttachMiddleware(logger zerolog.Logger) func(next http.Handler) http.Handler

+ type AcceptedResponse struct

+ CorrelationID string

+ Response interface{}

+ type ErrorResponse struct

+ CorrelationID string

+ Message string

+ type FieldError struct

+ Code string

+ Error string

+ Field string

+ Params map[string]string

+ type ForbiddenResponse struct

+ CorrelationID string

+ Message string

+ type NotFoundResponse struct

+ CorrelationID string

+ Message string

+ type OKListResponse struct

+ CorrelationID string

+ Items []T

+ Pagination Pagination

+ type OKResponse struct

+ CorrelationID string

+ Response interface{}

+ type Pagination struct

+ Page int

+ ResultsPerPage int

+ TotalPages int

+ TotalResults int

+ type RequestErrors struct

+ CorrelationID string

+ Errors []string

+ FieldErrors []FieldError

+ func NewRequestErrors() RequestErrors

+ func (r RequestErrors) HasAnyError() bool

+ func (r RequestErrors) WithError(error string) RequestErrors

+ func (r RequestErrors) WithFieldError(field, error string) RequestErrors

+ func (r RequestErrors) WithFieldErrorCode(field, code string, params map[string]string) RequestErrors

+ type RestAPIConfig struct

+ CORSAllowedOrigins []string

+ DeadlineBuffer time.Duration

+ type RootRouters struct

+ AuthRouter http.Handler

+ CarsRouter http.Handler

+ DeveloperRouter http.Handler

+ DriverRouter http.Handler

+ HealthRouter http.Handler

+ IngestionRouter http.Handler

+ SeriesRouter http.Handler

+ SessionRouter http.Handler

+ TracksRouter http.Handler

+ type TokenValidator interface

+ ValidateToken func(ctx context.Context, tokenString string) (*auth.SessionClaims, *auth.SensitiveClaims, error)

+ type TooManyRequestsResponse struct

+ CorrelationID string

+ Message string

+ RetryAfter int

+ type UnauthorizedResponse struct

+ CorrelationID string

+ Message string