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. |
|
http/middleware/decompress
Package decompress implements a middleware around decompression.
|
Package decompress implements a middleware around decompression. |
|
http/middleware/headcontent
Package headcontent implements a middleware around content HTTP headers.
|
Package headcontent implements a middleware around content HTTP headers. |
|
http/middleware/maxbytes
Package maxbytes implements a middleware around HTTP request size.
|
Package maxbytes implements a middleware around HTTP request size. |
|
http/middleware/oteli
Package oteli implements a middleware around OpenTelemetry instrumentation.
|
Package oteli implements a middleware around OpenTelemetry instrumentation. |
|
http/middleware/recovery
Package recovery implements a middleware around panic recovery.
|
Package recovery implements a middleware around panic recovery. |
|
http/middleware/redirect
Package redirect implements a middleware around HTTP redirection.
|
Package redirect implements a middleware around HTTP redirection. |
|
http/middleware/reqlog
Package reqlog implements a middleware around HTTP request logging.
|
Package reqlog implements a middleware around HTTP request logging. |
|
http/middleware/sechead
Package sechead implements a middleware around security HTTP headers.
|
Package sechead implements a middleware around security HTTP headers. |
|
http/middleware/sunset
Package sunset implements a middleware around sunset HTTP headers.
|
Package sunset implements a middleware around sunset HTTP headers. |
|
http/middleware/timeout
Package timeout implements a middleware around HTTP timeout.
|
Package timeout implements a middleware around HTTP timeout. |
|
http/nfs
Package nfs implements helpers around filesystems.
|
Package nfs implements helpers around filesystems. |
|
http/resp
Package resp implements helpers around HTTP responses.
|
Package resp implements helpers around HTTP responses. |
|
http/router
Package router implements a simple HTTP router with middleware capabilities.
|
Package router implements a simple HTTP router with middleware capabilities. |
|
http/server
Package server implements helpers around HTTP server lifecycle management.
|
Package server implements helpers around HTTP server lifecycle management. |
|
http/tmpl
Package tmpl implements helpers around html/template.
|
Package tmpl implements helpers around html/template. |
|
pgerrcode
Package pgerrcode implements constant definitions for PostgreSQL error codes.
|
Package pgerrcode implements constant definitions for PostgreSQL error codes. |
|
pki/ca
Package ca implements helpers around certificate authority.
|
Package ca implements helpers around certificate authority. |
|
retry
Package retry implements helpers around retry logic.
|
Package retry implements helpers around retry logic. |
|
semver
Package semver implements helpers around [semantic versioning].
|
Package semver implements helpers around [semantic versioning]. |
|
shutdown
Package shutdown implements helpers around shutdown logic.
|
Package shutdown implements helpers around shutdown logic. |
|
sse
Package sse implements helpers around Server Sent Events.
|
Package sse implements helpers around Server Sent Events. |
Click to show internal directories.
Click to hide internal directories.