builder

Documentation

Index

• type AsyncAPISpec
• type SpecBuilder
  • func (b *SpecBuilder) AddMessage(msg spec.MessageSpec) *SpecBuilder
  • func (b *SpecBuilder) AddServerInfo(info spec.ServerSpec) *SpecBuilder
  • func (b *SpecBuilder) Build() AsyncAPISpec

Types

type AsyncAPISpec

type AsyncAPISpec struct {
	AsyncAPI   string           `json:"asyncapi"`
	Info       information      `json:"info"`
	Topics     map[string]topic `json:"topics"`
	Components components       `json:"components"`
}

AsyncAPISpec represent the asyncapi data structure

type SpecBuilder

type SpecBuilder struct {
	Spec AsyncAPISpec
}

SpecBuilder builds a spec using the builder pattern

func (*SpecBuilder) AddMessage

func (b *SpecBuilder) AddMessage(msg spec.MessageSpec) *SpecBuilder

AddMessage inserts the information for a message in the asyncapi spec

func (*SpecBuilder) AddServerInfo

func (b *SpecBuilder) AddServerInfo(info spec.ServerSpec) *SpecBuilder

AddServerInfo adds the server information to the asyncapi spec

func (*SpecBuilder) Build

func (b *SpecBuilder) Build() AsyncAPISpec

Build builds the final asyncapi spec