specs

package

v1.0.7 Latest Latest Go to latest Published: Jan 11, 2026 License: Apache-2.0 Imports: 0 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/aatuh/api-toolkit

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables

Constants ¶

View Source

const (
	// Health check endpoints
	Livez          = "/livez"
	Readyz         = "/readyz"
	Healthz        = "/healthz"
	Health         = "/health"
	HealthDetailed = "/health/detailed"

	// Documentation endpoints
	Docs        = "/docs"
	DocsOpenAPI = "/docs/openapi.json"
	DocsVersion = "/docs/version"
	DocsInfo    = "/docs/info"

	// System endpoints
	Version = "/version"

	// Metrics endpoint (Prometheus)
	Metrics = "/metrics"

	// Pprof endpoints for runtime profiling.
	PprofIndex   = "/debug/pprof/"
	PprofCmdline = "/debug/pprof/cmdline"
	PprofProfile = "/debug/pprof/profile"
	PprofSymbol  = "/debug/pprof/symbol"
	PprofTrace   = "/debug/pprof/trace"
)

System endpoints for health checks and documentation

Variables ¶

View Source

var AllEndpoints = struct {
	Health interface{}
	Docs   interface{}
	System interface{}
}{
	Health: HealthEndpoints,
	Docs:   DocsEndpoints,
	System: SystemEndpoints,
}

AllEndpoints groups all available endpoints

View Source

var DocsEndpoints = struct {
	Docs    string
	OpenAPI string
	Version string
	Info    string
}{
	Docs:    Docs,
	OpenAPI: DocsOpenAPI,
	Version: DocsVersion,
	Info:    DocsInfo,
}

DocsEndpoints groups all documentation-related endpoints

View Source

var HealthEndpoints = struct {
	Livez          string
	Readyz         string
	Healthz        string
	Health         string
	HealthDetailed string
}{
	Livez:          Livez,
	Readyz:         Readyz,
	Healthz:        Healthz,
	Health:         Health,
	HealthDetailed: HealthDetailed,
}

HealthEndpoints groups all health-related endpoints

View Source

var PprofEndpoints = struct {
	Index   string
	Cmdline string
	Profile string
	Symbol  string
	Trace   string
}{
	Index:   PprofIndex,
	Cmdline: PprofCmdline,
	Profile: PprofProfile,
	Symbol:  PprofSymbol,
	Trace:   PprofTrace,
}

PprofEndpoints groups all profiling endpoints.

View Source

var SystemEndpoints = struct {
	Version string
}{
	Version: Version,
}

SystemEndpoints groups all system-related endpoints

Functions ¶

This section is empty.

Types ¶

This section is empty.

Source Files ¶

View all Source files

endpoints.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL