Skip to content
gin-kit gopher mascotgin-kit gopher mascotgin-kit

Runtime API map

Runtime projects import versioned packages from github.com/Alfian57/gin-kit/runtime/.... This map is an entry point, not a second copy of GoDoc: use it to choose the package, follow the linked guide for the workflow, and use the package documentation for every option and method.

Application foundation

Section titled “Application foundation”
Package Start with Guide
runtime runtime.New, Application.Run, Application.Go Customizing the runtime
runtime/config LoadDotenv, Load, Config.Options Configuration
runtime/database Open, Connection Database and ORM
runtime/httpx BindJSON, OK, Handle Responses and validation
runtime/validation New, RegisterRule, Struct Validation
runtime/query Parse, BuildSQL, ApplyGORM Filtering and pagination
runtime/openapi NewRegistry, Describe, Build API documentation

Identity and security

Section titled “Identity and security”
Package Start with Guide
runtime/auth New, RequireAuth, RequireToken Authentication and security
runtime/authz Allow, Deny, Authorize Authorization
runtime/oauth NewManager, NewGoogle, NewGitHub OAuth social sign-in
runtime/password Hash, Compare, Hasher Authentication and security
runtime/session Middleware, CSRF, PutFlash Sessions and CSRF

Background work, state, and delivery

Section titled “Background work, state, and delivery”
Package Start with Guide
runtime/cache NewMemory, NewRedis, Remember Caching and events
runtime/events NewBus, On, Emit Caching and events
runtime/queue New, Register, Dispatch Queues and scheduling
runtime/schedule New, Cron, Every Queues and scheduling
runtime/realtime New, Public, Private, SSE Realtime updates
runtime/mail New, NewMessage, Mailer.Send Mail, WhatsApp, and file storage
runtime/storage New, Put, SaveUpload Mail, WhatsApp, and file storage
runtime/whatsapp New, NewMessage, NewAuthenticationMessage WhatsApp Cloud API

Operations and testing

Section titled “Operations and testing”
Package Start with Guide
runtime/devtools New, Middleware, Mount Devtools dashboard
runtime/metrics New, Middleware, Handler Observability
runtime/flags FromEnv, Enabled, Set Customizing the runtime
runtime/factory Define, Seeded, Create Seeding and factories
runtime/apptest New, OpenSQLite, Client Testing
runtime/browsertest Launch, StartServer, Install Testing

The runtime intentionally does not create hidden dependencies between these packages. Construct the subsystem in application wiring, pass interfaces into your services, and register background runners through Application.Go.