health

Documentation

Index

• Constants
• Variables
• func NewShowEndpoint(s Service) endpoint.Endpoint
• type Client
  • func NewClient(show endpoint.Endpoint) *Client
  • func (c *Client) Show(ctx context.Context) (res string, err error)
• type Endpoints
  • func NewEndpoints(s Service) *Endpoints
  • func (e *Endpoints) Use(m func(endpoint.Endpoint) endpoint.Endpoint)
• type Service

Constants

const APIName = "archiver"

APIName is the name of the API as defined in the design.

const APIVersion = "0.0.1"

APIVersion is the version of the API as defined in the design.

const ServiceName = "health"

ServiceName is the name of the service as defined in the design. This is the same value that is set in the endpoint request contexts under the ServiceKey key.

Variables

var MethodNames = [1]string{"show"}

MethodNames lists the service method names as defined in the design. These are the same values that are set in the endpoint request contexts under the MethodKey key.

Functions

func NewShowEndpoint

func NewShowEndpoint(s Service) endpoint.Endpoint

NewShowEndpoint returns an endpoint function that calls the method "show" of service "health".

Types

type Client

type Client struct {
	ShowEndpoint endpoint.Endpoint
}

Client is the "health" service client.

func NewClient

func NewClient(show endpoint.Endpoint) *Client

NewClient initializes a "health" service client given the endpoints.

func (*Client) Show

func (c *Client) Show(ctx context.Context) (res string, err error)

Show calls the "show" endpoint of the "health" service.

type Endpoints

type Endpoints struct {
	Show endpoint.Endpoint
}

Endpoints wraps the "health" service endpoints.

func NewEndpoints

func NewEndpoints(s Service) *Endpoints

NewEndpoints wraps the methods of the "health" service with endpoints.

func (*Endpoints) Use

func (e *Endpoints) Use(m func(endpoint.Endpoint) endpoint.Endpoint)

Use applies the given middleware to all the "health" service endpoints.

type Service

type Service interface {
	// Health check endpoint
	Show(context.Context) (res string, err error)
}

Service is the health service interface.