README
¶
helpers
Shared Go helpers in one module and one release. MigrateKit remains separate.
| Import | Purpose | Runtime dependencies |
|---|---|---|
github.com/open-rails/helpers/api |
HTTP errors, responses, safe metadata and pagination | Standard library |
github.com/open-rails/helpers/api/gin |
Gin writers, query binding and locale helpers | API helpers and Gin |
github.com/open-rails/helpers/river |
Compose library jobs into one host-owned River client | River and pgx |
Import only the packages an application needs. The API core does not import Gin or River. Go builds the imported packages and their dependencies; all packages share this module's version and Go/toolchain requirements.
API helpers
The core provides typed errors, stable type/code fields, optional request IDs, bounded/sanitized metadata, JSON writers and generic list/message/deletion responses. The Gin adapter delegates to those writers and adds pagination binding and locale middleware. It does not add a router or authentication system. Existing response bytes are retained, including omitted codes/discriminators and preserved request IDs.
River composition
river.New combines library contributions, validates registration and binds their producers to the same ordinary River client and actual host pool. The host starts/stops that client and retains ownership of the pool. These helpers do not add a scheduler, migrate tables or own billing logic.
Validation
Use one entry point locally and in CI:
RIVER_TEST_DATABASE_URL='postgres://.../helpers_test?sslmode=disable' bash scripts/check.sh
It checks formatting, the single-module/package boundaries, vet/race tests, actual PostgreSQL River composition, the frozen frontend-parser fixtures and reachable vulnerabilities. For a quick API-only check, run go test ./api/....
api/compat contains frozen wire/parser evidence, not reverse dependencies on applications. Historical source-version comparisons and nested module publication tooling are retired. Original copyrights and source provenance are retained.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package api is the fleet's HTTP API envelope: one error shape, one type and code vocabulary, one status inference, and the list/pagination shapes that go with them.
|
Package api is the fleet's HTTP API envelope: one error shape, one type and code vocabulary, one status inference, and the list/pagination shapes that go with them. |
|
gin
Package ginapi writes api envelopes, lists and objects through a gin.Context, binds list parameters from the query string, and carries the locale middleware.
|
Package ginapi writes api envelopes, lists and objects through a gin.Context, binds list parameters from the query string, and carries the locale middleware. |
|
Package river composes library workers into one host-owned River client.
|
Package river composes library workers into one host-owned River client. |