package
4.1.3+incompatible
Repository: https://github.com/els0r/goprobe.git
Documentation: pkg.go.dev

# Functions

GenerateSpec writes the OpenAPI spec to a file.
NewDefault creates a new API server.
WithDebugMode runs the gin server in debug mode (e.g.
WithMetrics enables prometheus metrics endpoints.
WithProfiling enables runtime profiling endpoints.
WithQueryRateLimit enables a global rate limit for query calls.
WithTracing enables trace propagation.

# Constants

RuntimeIDHeaderKey denotes the header name / key that identifies the server runtime ID.

# Structs

DefaultServer is the default API server, allowing middlewares and settings to be re-used across binaries serving an API.

# Interfaces

OpenAPISpecWriter can be implemented by any server able to produce an OpenAPI spec from its registered routes.

# Type aliases

Option denotes a functional option fo a default server instance.