Directories
¶
| Path | Synopsis |
|---|---|
|
core
|
|
|
app
Package app wires the HTTP server, module registration, and lifecycle management.
|
Package app wires the HTTP server, module registration, and lifecycle management. |
|
auth
Package auth provides authentication context types and goAuth provider integration.
|
Package auth provides authentication context types and goAuth provider integration. |
|
cache
Package cache implements Redis-backed response caching and cache key generation utilities.
|
Package cache implements Redis-backed response caching and cache key generation utilities. |
|
config
Package config loads, normalizes, and validates runtime configuration from environment variables.
|
Package config loads, normalizes, and validates runtime configuration from environment variables. |
|
db
Package db provides Postgres connectivity and migrations for storage backends.
|
Package db provides Postgres connectivity and migrations for storage backends. |
|
errors
Package errors defines typed application errors used for consistent API responses.
|
Package errors defines typed application errors used for consistent API responses. |
|
httpx
Package httpx contains HTTP adapters, middleware, and router helpers used by modules.
|
Package httpx contains HTTP adapters, middleware, and router helpers used by modules. |
|
logx
Package logx wraps structured logging setup and logger configuration.
|
Package logx wraps structured logging setup and logger configuration. |
|
metrics
Package metrics provides Prometheus instrumentation for HTTP, readiness, and policy signals.
|
Package metrics provides Prometheus instrumentation for HTTP, readiness, and policy signals. |
|
modulekit
Package modulekit provides module-safe accessors for runtime dependencies.
|
Package modulekit provides module-safe accessors for runtime dependencies. |
|
netx
Package netx contains network helpers such as trusted client IP extraction.
|
Package netx contains network helpers such as trusted client IP extraction. |
|
params
Package params provides normalized request parameter helper functions.
|
Package params provides normalized request parameter helper functions. |
|
policy
Package policy provides route-level middleware for auth, RBAC, tenant checks, rate limiting, and cache control.
|
Package policy provides route-level middleware for auth, RBAC, tenant checks, rate limiting, and cache control. |
|
ratelimit
Package ratelimit implements Redis-backed rate limiting primitives and keying strategies.
|
Package ratelimit implements Redis-backed rate limiting primitives and keying strategies. |
|
readiness
Package readiness aggregates dependency health into a sanitized readiness report.
|
Package readiness aggregates dependency health into a sanitized readiness report. |
|
requestid
Package requestid defines request-id context storage and retrieval helpers.
|
Package requestid defines request-id context storage and retrieval helpers. |
|
response
Package response writes API envelopes and error payloads with centralized sanitization.
|
Package response writes API envelopes and error payloads with centralized sanitization. |
|
storage
Package storage defines the enforced data-layer contracts used by repositories.
|
Package storage defines the enforced data-layer contracts used by repositories. |
|
tenant
Package tenant provides tenant-scope utilities used by auth and policy layers.
|
Package tenant provides tenant-scope utilities used by auth and policy layers. |
|
tracing
Package tracing configures OpenTelemetry provider lifecycle for the API process.
|
Package tracing configures OpenTelemetry provider lifecycle for the API process. |
|
devx
|
|
|
modulegen
Package modulegen provides scaffolding utilities for creating new API modules.
|
Package modulegen provides scaffolding utilities for creating new API modules. |
|
modulesync
Package modulesync syncs module-local SQL assets into global sqlc input folders.
|
Package modulesync syncs module-local SQL assets into global sqlc input folders. |
|
Package modules registers built-in runtime modules for the API process.
|
Package modules registers built-in runtime modules for the API process. |
|
health
Package health exposes liveness and readiness endpoints as an app module.
|
Package health exposes liveness and readiness endpoints as an app module. |
|
system
Package system provides system-level example routes, auth demos, and utility endpoints.
|
Package system provides system-level example routes, auth demos, and utility endpoints. |
|
tools
|
|
|
validator
Package validator statically validates route policy wiring for SuperAPI modules.
|
Package validator statically validates route policy wiring for SuperAPI modules. |
Click to show internal directories.
Click to hide internal directories.