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

api

package

Go to main page

Versions in this module

v4

v4.1.14

Mar 11, 2025

v4.1.13

Mar 11, 2025

v4.1.12

Mar 10, 2025

v4.1.11

Mar 5, 2025

Changes in this version

+ const HealthRoute

+ const InfoRoute

+ const QueryRoute

+ const ReadyRoute

+ const SSEQueryRoute

+ const ValidationRoute

+ var ErrTooManyConcurrentRequest = errors.New("too many concurrent requests")

+ func ExtractSchemeAddr(addr string) (scheme string, address string)

+ func ExtractUnixSocket(addr string) (socketFile string)

+ func GetHealthHandler() func(context.Context, *struct{}) (*GetHealthOutput, error)

+ func GetHealthOperation() huma.Operation

+ func GetInfoOperation() huma.Operation

+ func GetReadyHandler() func(context.Context, *struct{}) (*GetReadyOutput, error)

+ func GetReadyOperation() huma.Operation

+ func GetServiceInfoHandler(serviceName string) func(context.Context, *struct{}) (*GetInfoOutput, error)

+ func OnKeepalive(send sse.Sender) error

+ func OnResult(res *results.Result, send sse.Sender) error

+ func RateLimitMiddleware(limiter *rate.Limiter) func(ctx huma.Context, next func(huma.Context))

+ func RecursionDetectorMiddleware(headerKey, match string) gin.HandlerFunc

+ func RegisterProfiling(router *gin.Engine)

+ func RegisterQueryAPI(a huma.API, caller string, querier query.Runner, middlewares huma.Middlewares)

+ func RequestLoggingMiddleware() gin.HandlerFunc

+ func TraceIDMiddleware() gin.HandlerFunc

+ type ArgsInput struct

+ Body *query.Args

+ type ArgsParamsInput struct

+ type FinalResult struct

+ type GetHealthOutput struct

+ Body struct{ ... }

+ type GetInfoOutput struct

+ Body struct{ ... }

+ type GetReadyOutput struct

+ Body struct{ ... }

+ type Keepalive struct

+ type PartialResult struct

+ type QueryResultOutput struct

+ Body *results.Result

+ type SSEQueryRunner interface

+ RunStreaming func(ctx context.Context, args *query.Args, send sse.Sender) (*results.Result, error)

+ type ServiceInfo struct

+ Commit string

+ Name string

+ Pod string

+ Version string

+ type StreamEventType string

+ const StreamEventFinalResult

+ const StreamEventKeepalive

+ const StreamEventPartialResult

+ const StreamEventQueryError