endpoint

Documentation

Index

• func Generate(file File) ([]byte, error)
• type EndpointSet
• type File
• type Service

Functions

func Generate

func Generate(file File) ([]byte, error)

Generate generates Go kit endpoint sets for services.

Types

type EndpointSet

type EndpointSet struct {
	Service Service

	// ModuleName can be used instead of the package name in an operation name to uniquely identify a service call.
	//
	// Falls back to the package name.
	ModuleName string

	// WithOpenCensus enables generating a trace middleware for the endpoint set.
	WithOpenCensus bool

	// ErrorStrategy decides whether returned errors are checked for being endpoint or service errors.
	ErrorStrategy string
}

EndpointSet represents a set of endpoints for a single service. nolint: golint

type File

type File struct {
	gentypes.File

	// EndpointSets represents endpoints to be generated for each service in the package.
	EndpointSets []EndpointSet
}

File represents one or more services and provides information for generating endpoints for these services.

type Service

type Service struct {
	Object *types.TypeName
	Type   *types.Interface
}

Service represents a service interface.