helloworld

Documentation

Overview

Package helloworld implements the helloworld.example microservice.

The HelloWorld microservice demonstrates the classic minimalist example.

Index

• Constants
• type Mock
  • func NewMock() *Mock
• type Service
  • func NewService() *Service
  • func (svc *Service) HelloWorld(w http.ResponseWriter, r *http.Request) (err error)
  • func (svc *Service) Init(initializer func(svc *Service)) *Service
  • func (svc *Service) OnShutdown(ctx context.Context) (err error)
  • func (svc *Service) OnStartup(ctx context.Context) (err error)

Constants

const Hostname = "helloworld.example"

Hostname is the default hostname of the microservice: helloworld.example.

const SourceCodeSHA256 = "bef04c20e0d64c75a7c34e470c64b0b288b1f37bcba9336fc7fcccb4e5240c4f"

const Timestamp = "2025-07-12T16:29:55.930172Z"

const Version = 49

Types

type Mock

type Mock = intermediate.Mock

Mock is a mockable version of the helloworld.example microservice, allowing functions, event sinks and web handlers to be mocked.

func NewMock

func NewMock() *Mock

New creates a new mockable version of the microservice.

type Service

type Service struct {
	*intermediate.Intermediate // DO NOT REMOVE
}

Service implements the helloworld.example microservice.

The HelloWorld microservice demonstrates the classic minimalist example.

func NewService

func NewService() *Service

NewService creates a new helloworld.example microservice.

func (*Service) HelloWorld

func (svc *Service) HelloWorld(w http.ResponseWriter, r *http.Request) (err error)

HelloWorld prints the classic greeting.

func (*Service) Init

func (svc *Service) Init(initializer func(svc *Service)) *Service

Init enables a single-statement pattern for initializing the microservice.

svc.Init(func(svc Service) {
	svc.SetGreeting("Hello")
})

func (*Service) OnShutdown

func (svc *Service) OnShutdown(ctx context.Context) (err error)

OnShutdown is called when the microservice is shut down.

func (*Service) OnStartup

func (svc *Service) OnStartup(ctx context.Context) (err error)

OnStartup is called when the microservice is started up.