helloapi

package
v1.22.2 Latest Latest
Warning

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

 Go to latest Published: Feb 19, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	RouteOfHello        = `/hello`        // MARKER: Hello
	RouteOfEcho         = `/echo`         // MARKER: Echo
	RouteOfPing         = `/ping`         // MARKER: Ping
	RouteOfCalculator   = `/calculator`   // MARKER: Calculator
	RouteOfBusPNG       = `/bus.png`      // MARKER: BusPNG
	RouteOfLocalization = `/localization` // MARKER: Localization
	RouteOfRoot         = `//root`        // MARKER: Root
)

Endpoint routes.

View Source 
const Hostname = "hello.example"

Hostname is the default hostname of the microservice.

Variables

View Source 
var (
	URLOfHello        = httpx.JoinHostAndPath(Hostname, RouteOfHello)        // MARKER: Hello
	URLOfEcho         = httpx.JoinHostAndPath(Hostname, RouteOfEcho)         // MARKER: Echo
	URLOfPing         = httpx.JoinHostAndPath(Hostname, RouteOfPing)         // MARKER: Ping
	URLOfCalculator   = httpx.JoinHostAndPath(Hostname, RouteOfCalculator)   // MARKER: Calculator
	URLOfBusPNG       = httpx.JoinHostAndPath(Hostname, RouteOfBusPNG)       // MARKER: BusPNG
	URLOfLocalization = httpx.JoinHostAndPath(Hostname, RouteOfLocalization) // MARKER: Localization
	URLOfRoot         = httpx.JoinHostAndPath(Hostname, RouteOfRoot)         // MARKER: Root
)

Endpoint URLs.

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) BusPNG 

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

BusPNG serves an image from the embedded resources.

If a URL is provided, it is resolved relative to the URL of the endpoint.

func (Client) Calculator 

func (_c Client) Calculator(ctx context.Context, method string, relativeURL string, body any) (res *http.Response, err error)

Calculator renders a UI for a calculator. The calculation operation is delegated to another microservice in order to demonstrate a call from one microservice to another.

If a URL is provided, it is resolved relative to the URL of the endpoint. If the body is of type io.Reader, []byte or string, it is serialized in binary form. If it is of type url.Values, it is serialized as form data. All other types are serialized as JSON.

func (Client) Echo 

func (_c Client) Echo(ctx context.Context, method string, relativeURL string, body any) (res *http.Response, err error)

Echo back the incoming request in wire format.

If a URL is provided, it is resolved relative to the URL of the endpoint. If the body is of type io.Reader, []byte or string, it is serialized in binary form. If it is of type url.Values, it is serialized as form data. All other types are serialized as JSON.

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) Hello 

func (_c Client) Hello(ctx context.Context, method string, relativeURL string, body any) (res *http.Response, err error)

Hello prints a greeting.

If a URL is provided, it is resolved relative to the URL of the endpoint. If the body is of type io.Reader, []byte or string, it is serialized in binary form. If it is of type url.Values, it is serialized as form data. All other types are serialized as JSON.

func (Client) Localization 

func (_c Client) Localization(ctx context.Context, method string, relativeURL string, body any) (res *http.Response, err error)

Localization prints hello in the language best matching the request's Accept-Language header.

If a URL is provided, it is resolved relative to the URL of the endpoint. If the body is of type io.Reader, []byte or string, it is serialized in binary form. If it is of type url.Values, it is serialized as form data. All other types are serialized as JSON.

func (Client) Ping 

func (_c Client) Ping(ctx context.Context, method string, relativeURL string, body any) (res *http.Response, err error)

Ping all microservices and list them.

If a URL is provided, it is resolved relative to the URL of the endpoint. If the body is of type io.Reader, []byte or string, it is serialized in binary form. If it is of type url.Values, it is serialized as form data. All other types are serialized as JSON.

func (Client) Root 

func (_c Client) Root(ctx context.Context, method string, relativeURL string, body any) (res *http.Response, err error)

Root is the top-most root page.

If a URL is provided, it is resolved relative to the URL of the endpoint. If the body is of type io.Reader, []byte or string, it is serialized in binary form. If it is of type url.Values, it is serialized as form data. All other types are serialized as JSON.

func (Client) WithOptions added in v1.13.1 

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

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

type Hook added in v1.22.0 

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

Hook assists in the subscription to the events of the microservice.

func NewHook added in v1.22.0 

func NewHook(listener service.Subscriber) Hook

NewHook creates a new hook to the events of the microservice.

func (Hook) ForHost added in v1.22.0 

func (c Hook) ForHost(host string) Hook

ForHost returns a copy of the hook with a different hostname to be applied to the subscription.

func (Hook) WithOptions added in v1.22.0 

func (c Hook) WithOptions(opts ...sub.Option) Hook

WithOptions returns a copy of the hook with options to be applied to subscriptions.

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) BusPNG 

func (_c MulticastClient) BusPNG(ctx context.Context, relativeURL string) <-chan *pub.Response

BusPNG serves an image from the embedded resources.

If a URL is provided, it is resolved relative to the URL of the endpoint.

func (MulticastClient) Calculator 

func (_c MulticastClient) Calculator(ctx context.Context, method string, relativeURL string, body any) <-chan *pub.Response

Calculator renders a UI for a calculator. The calculation operation is delegated to another microservice in order to demonstrate a call from one microservice to another.

If a URL is provided, it is resolved relative to the URL of the endpoint. If the body is of type io.Reader, []byte or string, it is serialized in binary form. If it is of type url.Values, it is serialized as form data. All other types are serialized as JSON.

func (MulticastClient) Echo 

func (_c MulticastClient) Echo(ctx context.Context, method string, relativeURL string, body any) <-chan *pub.Response

Echo back the incoming request in wire format.

If a URL is provided, it is resolved relative to the URL of the endpoint. If the body is of type io.Reader, []byte or string, it is serialized in binary form. If it is of type url.Values, it is serialized as form data. All other types are serialized as JSON.

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) Hello 

func (_c MulticastClient) Hello(ctx context.Context, method string, relativeURL string, body any) <-chan *pub.Response

Hello prints a greeting.

If a URL is provided, it is resolved relative to the URL of the endpoint. If the body is of type io.Reader, []byte or string, it is serialized in binary form. If it is of type url.Values, it is serialized as form data. All other types are serialized as JSON.

func (MulticastClient) Localization 

func (_c MulticastClient) Localization(ctx context.Context, method string, relativeURL string, body any) <-chan *pub.Response

Localization prints hello in the language best matching the request's Accept-Language header.

If a URL is provided, it is resolved relative to the URL of the endpoint. If the body is of type io.Reader, []byte or string, it is serialized in binary form. If it is of type url.Values, it is serialized as form data. All other types are serialized as JSON.

func (MulticastClient) Ping 

func (_c MulticastClient) Ping(ctx context.Context, method string, relativeURL string, body any) <-chan *pub.Response

Ping all microservices and list them.

If a URL is provided, it is resolved relative to the URL of the endpoint. If the body is of type io.Reader, []byte or string, it is serialized in binary form. If it is of type url.Values, it is serialized as form data. All other types are serialized as JSON.

func (MulticastClient) Root 

func (_c MulticastClient) Root(ctx context.Context, method string, relativeURL string, body any) <-chan *pub.Response

Root is the top-most root page.

If a URL is provided, it is resolved relative to the URL of the endpoint. If the body is of type io.Reader, []byte or string, it is serialized in binary form. If it is of type url.Values, it is serialized as form data. All other types are serialized as JSON.

func (MulticastClient) WithOptions added in v1.13.1 

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

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

type MulticastTrigger added in v1.22.0 

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

MulticastTrigger is a lightweight proxy for triggering the events of the microservice.

func NewMulticastTrigger added in v1.22.0 

func NewMulticastTrigger(caller service.Publisher) MulticastTrigger

NewMulticastTrigger creates a new multicast trigger of events of the microservice.

func (MulticastTrigger) ForHost added in v1.22.0 

func (_c MulticastTrigger) ForHost(host string) MulticastTrigger

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

func (MulticastTrigger) WithOptions added in v1.22.0 

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

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.