examples/

Package adapters-chi demonstrates the three-layer codec pipeline pattern using the chi router.

Package adapters-chi-security demonstrates authentication and authorization for REST APIs built with go-codex and the chi router adapter.

Package adapters-mqtt demonstrates the three-layer codec pipeline pattern for event-driven / MQTT applications.

Package adapters-mqtt-security demonstrates SecurityFunc-based authentication for MQTT subscribe channels built with go-codex.

Package adapters-nethttp demonstrates the three-layer codec pipeline pattern where every boundary — HTTP request, database, HTTP response — is modelled as a codec contract.

Package adapters-nethttp-security demonstrates authentication and authorization for REST APIs built with go-codex and the net/http adapter.

Package adapters-sse demonstrates Server-Sent Events (SSE) using the go-codex adapters/nethttp and adapters/chi adapters.

Package main demonstrates two templ + go-codex patterns on a single server:

Package main demonstrates how go-codex fits into a templ-based rendering pipeline using the adapters/templ format plug-in.

Package api-events demonstrates the api/events builder: define channels with codec-backed payload types, get typed Decode/Encode helpers, and generate a full AsyncAPI 3.0 spec — all without importing any messaging library.

Package api-rest demonstrates the api/rest builder: define routes with codec-backed types, get typed Decode/Encode helpers, and generate a full OpenAPI 3.1 spec — all without importing net/http or any HTTP framework.

Package main demonstrates using go-codex for CLI tool configuration: loading a TOML config file and overlaying environment variable overrides.

Package main demonstrates three patterns for reusing and transforming codecs without repeating constraint definitions.

Package decode-errors demonstrates multi-field validation errors in go-codex.

Package main demonstrates format.FromEnv: loading application configuration exclusively from environment variables using the codec as the single source of truth for field names, types, validations, and documentation.

Package error-types demonstrates every structured error type in go-codex.

Package event-driven demonstrates generating a full AsyncAPI 3.0 document from channel descriptors and Codec-derived schemas using the render/asyncapi/v3 package.

Package forge-collection demonstrates forge collection operations applied to a batch of MQTT-style sensor temperature readings.

Package main demonstrates the forge package for signed, governed KPI computation.

Package formats demonstrates the builtin format constraints in validate/, as well as WithExample, WithDeprecated, and the Duration codec.

Package main demonstrates where go-codex shines in a comment moderation use case: a single codec definition simultaneously escapes HTML, enforces length limits, and documents the schema — all derived from one value.

Package oee-chain demonstrates the three-layer go-codex architecture end-to-end:

Package openapi demonstrates generating an OpenAPI components/schemas section from Codec definitions using the render/openapi package.

Package png-upload demonstrates how to define REST routes for PNG binary transfer using go-codex:

Package rest-api demonstrates generating a full OpenAPI 3.1 document from route descriptors and Codec-derived schemas using the render/openapi package.

Package stats-observer demonstrates how to use stats.ValidationObserver and stats.ReportErrors with codecs directly — without any HTTP or MQTT adapter.

Package main shows how to use Codec.Validate and Format.Validate for explicit bidirectional validation.