asyncapi

Documentation

Index

• type Any
  • func NewAny() Any
  • func (a Any) IsFieldRequired(field string) bool
  • func (a *Any) MergeWith(spec Specification, a2 Any)
  • func (a *Any) Process(name string, spec Specification, isRequired bool)
• type Channel
  • func (c Channel) GetChannelMessage() *Message
  • func (c *Channel) Process(path string, spec Specification)
• type Components
  • func (c *Components) Process(spec Specification)
• type CorrelationID
• type Extensions
• type GoTypeImportExtension
• type GoTypeImportName
• type GoTypeImportPath
• type Info
• type Message
  • func (msg *Message) MergeWith(spec Specification, msg2 Message)
  • func (msg *Message) Process(name string, spec Specification)
• type Operation
• type Parameter
  • func (p *Parameter) Process(name string, spec Specification)
• type Specification
  • func (s Specification) CustomImports() ([]string, error)
  • func (s Specification) GetPublishSubscribeCount() (publishCount, subscribeCount uint)
  • func (s *Specification) Process()
  • func (s Specification) ReferenceAny(ref string) *Any
  • func (s Specification) ReferenceMessage(ref string) *Message
  • func (s Specification) ReferenceParameter(ref string) *Parameter

Types

type Any

type Any struct {
	AllOf       []*Any          `json:"allOf"`
	AnyOf       []*Any          `json:"anyOf"`
	OneOf       []*Any          `json:"oneOf"`
	Type        string          `json:"type"`
	Description string          `json:"description"`
	Format      string          `json:"format"`
	Properties  map[string]*Any `json:"properties"`
	Items       *Any            `json:"items"`
	Reference   string          `json:"$ref"`
	Required    []string        `json:"required"`

	// Non AsyncAPI fields
	Name        string `json:"-"`
	ReferenceTo *Any   `json:"-"`
	IsRequired  bool   `json:"-"`

	// Embedded extended fields
	Extensions
}

func NewAny

func NewAny() Any

func (Any) IsFieldRequired

func (a Any) IsFieldRequired(field string) bool

func (*Any) MergeWith

func (a *Any) MergeWith(spec Specification, a2 Any)

func (*Any) Process

func (a *Any) Process(name string, spec Specification, isRequired bool)

type Channel

type Channel struct {
	Parameters map[string]*Parameter `json:"parameters"`

	Subscribe *Operation `json:"subscribe"`
	Publish   *Operation `json:"publish"`

	// Non AsyncAPI fields
	Name string `json:"-"`
	Path string `json:"-"`
}

func (Channel) GetChannelMessage

func (c Channel) GetChannelMessage() *Message

GetChannelMessage will return the channel message WARNING: if there is a reference, then it won't be followed.

func (*Channel) Process

func (c *Channel) Process(path string, spec Specification)

type Components

type Components struct {
	Messages   map[string]*Message   `json:"messages"`
	Schemas    map[string]*Any       `json:"schemas"`
	Parameters map[string]*Parameter `json:"parameters"`
}

func (*Components) Process

func (c *Components) Process(spec Specification)

type CorrelationID

type CorrelationID struct {
	Description string `json:"description"`
	Location    string `json:"location"`
}

type Extensions

type Extensions struct {
	// Setting custom Go type when generating schemas
	ExtGoType string `json:"x-go-type"`

	// Setting custom import statements for ExtGoType
	ExtGoTypeImport *GoTypeImportExtension `json:"x-go-type-import"`
}

Extensions holds additional properties defined for asyncapi-codegen that are out of the AsyncAPI spec.

type GoTypeImportExtension

type GoTypeImportExtension struct {
	Name GoTypeImportName `json:"name"` // Package name for import, optional
	Path GoTypeImportPath `json:"path"` // Path to package to import
}

GoTypeImportExtension specifies the required import statement for the x-go-type extension. For example, GoTypeImportExtension{Name: "myuuid", Path: "github.com/google/uuid"} will generate `import myuuid github.com/google/uuid`

type GoTypeImportName

type GoTypeImportName string // Import name type for x-go-type-import

type GoTypeImportPath

type GoTypeImportPath string // Import path type for x-go-type-import

type Info

type Info struct {
	Title       string `json:"title"`
	Version     string `json:"version"`
	Description string `json:"description"`
}

type Message

type Message struct {
	Description   string         `json:"description"`
	Headers       *Any           `json:"headers"`
	OneOf         []*Message     `json:"oneOf"`
	Payload       *Any           `json:"payload"`
	CorrelationID *CorrelationID `json:"correlationID"`
	Reference     string         `json:"$ref"`

	// --- Non AsyncAPI fields -------------------------------------------------
	Name        string   `json:"-"`
	ReferenceTo *Message `json:"-"`

	// CorrelationIDLocation will indicate where the correlation id is
	// According to: https://www.asyncapi.com/docs/reference/specification/v2.6.0#correlationIDObject
	CorrelationIDLocation string `json:"-"`
	CorrelationIDRequired bool   `json:"-"`
}

func (*Message) MergeWith

func (msg *Message) MergeWith(spec Specification, msg2 Message)

func (*Message) Process

func (msg *Message) Process(name string, spec Specification)

type Operation

type Operation struct {
	Message Message `json:"message"`
}

type Parameter

type Parameter struct {
	Description string `json:"description"`
	Schema      *Any   `json:"schema"`
	Location    string `json:"location"`
	Reference   string `json:"$ref"`

	// Non AsyncAPI fields
	Name        string     `json:"-"`
	ReferenceTo *Parameter `json:"-"`
}

func (*Parameter) Process

func (p *Parameter) Process(name string, spec Specification)

type Specification

type Specification struct {
	Version    string              `json:"asyncapi"`
	Info       Info                `json:"info"`
	Channels   map[string]*Channel `json:"channels"`
	Components Components          `json:"components"`
}

func (Specification) CustomImports

func (s Specification) CustomImports() ([]string, error)

CustomImports collects all custom import paths set by x-go-type-imports in all Schema Objects in the Specification. Returns import strings like `alias "abc.xyz/repo/package"` for code generation. Returns error when import name conflicts.

func (Specification) GetPublishSubscribeCount

func (s Specification) GetPublishSubscribeCount() (publishCount, subscribeCount uint)

GetPublishSubscribeCount gets the count of 'publish' channels and the count of 'subscribe' channels inside the Specification

func (*Specification) Process

func (s *Specification) Process()

func (Specification) ReferenceAny

func (s Specification) ReferenceAny(ref string) *Any

func (Specification) ReferenceMessage

func (s Specification) ReferenceMessage(ref string) *Message

func (Specification) ReferenceParameter

func (s Specification) ReferenceParameter(ref string) *Parameter