README
¶
kmicro - The lightweight microservice framework for Go
kmicro is a lean microservice framework built for Go developers who adhere to Go idioms and seek simplicity.
Install
go get -u codeberg.org/kema/kmicro
Contributing
Information about contributing to the project is available in CONTRIBUTING.md.
Directories
¶
| Path | Synopsis |
|---|---|
|
pkg
|
|
|
bytesdef
Package bytesdef implements helpers around bytes sizes representation.
|
Package bytesdef implements helpers around bytes sizes representation. |
|
client/cache/cachelocal
Package cachelocal implements helpers around a local cache.
|
Package cachelocal implements helpers around a local cache. |
|
client/database/dbpostgresql
Package dbpostgresql implements helpers around pgxpool.Pool.
|
Package dbpostgresql implements helpers around pgxpool.Pool. |
|
client/database/otelpgx
Package otelpgx implements OpenTelemetry instrumentation helpers around github.com/jackc/pgx/v5/pgxpool.Pool.
|
Package otelpgx implements OpenTelemetry instrumentation helpers around github.com/jackc/pgx/v5/pgxpool.Pool. |
|
client/httpclient
Package httpclient implements helpers around http.Client.
|
Package httpclient implements helpers around http.Client. |
|
client/otel/otelsetup
Package otelsetup implements helpers around OpenTelemetry SDK setup.
|
Package otelsetup implements helpers around OpenTelemetry SDK setup. |
|
conventionalcommit
Package conventionalcommit implements helpers around [conventional commits].
|
Package conventionalcommit implements helpers around [conventional commits]. |
|
crud
Package crud implements helpers around [CRUD] operations.
|
Package crud implements helpers around [CRUD] operations. |
|
crudpg
Package crudpg implements helpers around PostgreSQL errors for codeberg.org/kema/kmicro/pkg/crud.
|
Package crudpg implements helpers around PostgreSQL errors for codeberg.org/kema/kmicro/pkg/crud. |
|
dbmigration/dbm
Package dbm implements base interfaces for database migrations.
|
Package dbm implements base interfaces for database migrations. |
|
dbmigration/driver/dbmpgx
Package dbmpgx implements dbm.Driver from pgxpool.Pool.
|
Package dbmpgx implements dbm.Driver from pgxpool.Pool. |
|
dbmigration/source/dbmfs
Package dbmfs implements dbm.Source from fs.FS.
|
Package dbmfs implements dbm.Source from fs.FS. |
|
dbmigration/source/dbmgo
Package dbmgo implements dbm.Source from dbm.Migration go code.
|
Package dbmgo implements dbm.Source from dbm.Migration go code. |
|
envparse
Package envparse implements an environment variable parser.
|
Package envparse implements an environment variable parser. |
|
fallbacklog
Package fallbacklog implements a fallback logger.
|
Package fallbacklog implements a fallback logger. |
|
fswatch
Package fswatch implements a filesystem watcher.
|
Package fswatch implements a filesystem watcher. |
|
hotreload
Package hotreload implements helpers around code hot reloading.
|
Package hotreload implements helpers around code hot reloading. |
|
http/head
Package head implements helpers around cache HTTP headers.
|
Package head implements helpers around cache HTTP headers. |
|
http/health
Package health implements helpers around HTTP endpoints for server health.
|
Package health implements helpers around HTTP endpoints for server health. |
|
http/httpconfig
Package httpconfig implements helpers around HTTP server configuration.
|
Package httpconfig implements helpers around HTTP server configuration. |
|
http/jbody
Package jbody implements helpers around HTTP request bodies in JSON format.
|
Package jbody implements helpers around HTTP request bodies in JSON format. |
|
http/jsonproblem
Package jsonproblem implements a definition of JSON problem, as per [RFC 9457].
|
Package jsonproblem implements a definition of JSON problem, as per [RFC 9457]. |
|
http/middleware/cachehead
Package cachehead implements a middleware around cache HTTP headers.
|
Package cachehead implements a middleware around cache HTTP headers. |
|
http/middleware/compress
Package compress implements a middleware around compression.
|
Package compress implements a middleware around compression. |
|
http/middleware/crossprotect
Package crossprotect implements a middleware around cross origin resource protection.
|
Package crossprotect implements a middleware around cross origin resource protection. |