helloworldapi

package
v1.44.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 3, 2026 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source
const Description = `The HelloWorld microservice demonstrates the classic minimalist example.`

Description is the human-readable summary of the microservice, surfaced in OpenAPI and discovery.

View Source
const Hostname = "helloworld.example"

Hostname is the default hostname of the microservice.

View Source
const Name = "HelloWorld"

Name is the decorative PascalCase name of the microservice.

View Source
const Version = 82

Version is a generation counter bumped on each regeneration, not a semantic version.

Variables

View Source
var HelloWorld = define.Web{
	Host: Hostname, Method: "GET", Route: "/hello-world",
}

HelloWorld prints the classic greeting.

Functions

This section is empty.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a lightweight proxy for making unicast calls to the microservice.

func NewClient

func NewClient(caller service.Publisher) Client

NewClient creates a new unicast client proxy to the microservice.

func (Client) ForHost

func (_c Client) ForHost(host string) Client

ForHost returns a copy of the client with a different hostname to be applied to requests.

func (Client) HelloWorld

func (_c Client) HelloWorld(ctx context.Context, relativeURL string) (res *http.Response, err error)

HelloWorld prints the classic greeting.

func (Client) WithOptions

func (_c Client) WithOptions(opts ...pub.Option) Client

WithOptions returns a copy of the client with options to be applied to requests.

type MulticastClient

type MulticastClient struct {
	// contains filtered or unexported fields
}

MulticastClient is a lightweight proxy for making multicast calls to the microservice.

func NewMulticastClient

func NewMulticastClient(caller service.Publisher) MulticastClient

NewMulticastClient creates a new multicast client proxy to the microservice.

func (MulticastClient) ForHost

func (_c MulticastClient) ForHost(host string) MulticastClient

ForHost returns a copy of the client with a different hostname to be applied to requests.

func (MulticastClient) HelloWorld

func (_c MulticastClient) HelloWorld(ctx context.Context, relativeURL string) iter.Seq[*pub.Response]

HelloWorld prints the classic greeting.

func (MulticastClient) WithOptions

func (_c MulticastClient) WithOptions(opts ...pub.Option) MulticastClient

WithOptions returns a copy of the client with options to be applied to requests.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL