codegen

Documentation

Index

• Variables
• type CodeGen
  • func FromFile(path string) (CodeGen, error)
  • func FromJSON(data []byte) (CodeGen, error)
  • func FromYAML(data []byte) (CodeGen, error)
  • func New(spec asyncapi.Specification) CodeGen
  • func (cg CodeGen) Generate(opt Options) error
• type Options

Variables

var (
	// ErrInvalidBroker is an error raised when using an unknown broker.
	ErrInvalidBroker = fmt.Errorf("%w: invalid broker", extensions.ErrAsyncAPI)

	// ErrInvalidFileFormat is returned when using an invalid format for AsyncAPI specification.
	ErrInvalidFileFormat = fmt.Errorf("%w: invalid file format", extensions.ErrAsyncAPI)
)

Types

type CodeGen

type CodeGen struct {
	Specification asyncapi.Specification
	ModulePath    string
	ModuleVersion string
}

CodeGen is the main structure for the code generation.

func FromFile

func FromFile(path string) (CodeGen, error)

FromFile parses the AsyncAPI specification either from a YAML file or a JSON file.

func FromJSON

func FromJSON(data []byte) (CodeGen, error)

FromJSON parses the AsyncAPI specification from a JSON file.

func FromYAML

func FromYAML(data []byte) (CodeGen, error)

FromYAML parses the AsyncAPI specification from a YAML file.

func New

func New(spec asyncapi.Specification) CodeGen

New creates a new code generation structure that can be used to generate code.

func (CodeGen) Generate

func (cg CodeGen) Generate(opt Options) error

Generate generates code from the code generation structure, that have already processed the AsyncAPI file when creating it.

type Options

type Options struct {
	// OutputPath is the path to the generated code file
	OutputPath string

	// PackageName is the package name of the generated code
	PackageName string

	// Generate contains options regarding which golang code should be generated
	Generate generators.Options

	// DisableFormatting states if the formatting should be disabled when
	// writing the generated code
	DisableFormatting bool
}

Options is the struct that gather configuration of codegen.