endpointgen

Documentation

Index

• type Generator
  • func (Generator) CheckFilter() loader.NodeFilter
  • func (g Generator) Generate(ctx *genall.GenerationContext) error
  • func (g Generator) RegisterMarkers(into *markers.Registry) error
• type Marker

Types

type Generator

type Generator struct {
	// HeaderFile specifies the header text (e.g. license) to prepend to generated files.
	HeaderFile string `marker:",optional"`

	// Year specifies the year to substitute for " YEAR" in the header file.
	Year string `marker:",optional"`
}

Generator generates a Go kit Endpoint for a service.

func (Generator) CheckFilter

func (Generator) CheckFilter() loader.NodeFilter

func (Generator) Generate

func (g Generator) Generate(ctx *genall.GenerationContext) error

func (Generator) RegisterMarkers

func (g Generator) RegisterMarkers(into *markers.Registry) error

type Marker

type Marker struct {
	// BaseName specifies a base name for the service (other than the one automatically generated).
	//
	// When not specified falls back to base name created from the service name.
	BaseName string `marker:"baseName,optional"`

	// 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 `marker:"moduleName,optional"`

	// WithOpenCensus enables generating a TraceEndpoint middleware.
	WithOpenCensus bool `marker:"withOpenCensus,optional"`

	// ErrorStrategy decides whether returned errors are checked for being endpoint or service errors.
	ErrorStrategy string `marker:"errorStrategy,optional"`
}

Marker enables generating an endpoint for a service and provides information to the generator.