Documentation
¶
Overview ¶
Package ports provides stable generic utilities used across independent core packages: Logger, Clock, and IDGen. Domain, HTTP, persistence, and adapter contracts live with the package that consumes them or in github.com/aatuh/api-toolkit/contrib/v4/contracts. See docs/v4-plan.md for the v4 ownership boundary.
Purpose: See the package summary above. Import: `github.com/aatuh/api-toolkit/v4/ports`. Example: See docs/api-reference.md for package example links and docs/cookbook.md for task recipes. Errors: Constructors, parsers, and handlers return or write documented errors according to their signatures; packages with plain data types do not add hidden error channels. Concurrency: Treat configured middleware and helpers as immutable after construction; request and response values remain request-scoped unless a type documents stronger guarantees. Stability: Stable core API under VERSIONING.md and scripts/apicheck.sh. When not to use: Prefer net/http, application-owned types, or narrower helpers when this package contract is not needed.
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Logger ¶
type Logger interface {
Debug(msg string, kv ...any)
Info(msg string, kv ...any)
Warn(msg string, kv ...any)
Error(msg string, kv ...any)
}
Logger is a tiny façade to avoid vendor lock-in.
type NopLogger ¶
type NopLogger struct{}
NopLogger is a no-op logger for safe defaults.
Example ¶
package main
import (
"github.com/aatuh/api-toolkit/v4/ports"
)
func main() {
var logger ports.Logger = ports.NopLogger{}
logger.Info("request completed", "request_id", "req_123")
}
Output:
Source Files