generator

package

Go to main page

Versions in this module

v1

v1.0.0

Nov 8, 2025

Changes in this version

type AsyncAPIMessage

+ Extensions map[string]interface{}

type AsyncAPIOperation

+ Extensions map[string]interface{}

type AsyncAPISchema

+ Const interface{}

type AsyncAPISecurityScheme

+ Flows map[string]interface{}

v0

v0.2.1

Aug 27, 2025

Changes in this version

+ type AsyncAPIChannel struct

+ Address string

+ Bindings map[string]interface{}

+ Description string

+ ExternalDocs *AsyncAPIExternalDocs

+ Messages map[string]*AsyncAPIMessage

+ Parameters map[string]*AsyncAPIParameter

+ Servers []map[string]string

+ Summary string

+ Tags []*AsyncAPITag

+ Title string

+ type AsyncAPIComponents struct

+ Channels map[string]*AsyncAPIChannel

+ ExternalDocs map[string]*AsyncAPIExternalDocs

+ Messages map[string]*AsyncAPIMessage

+ Operations map[string]*AsyncAPIOperation

+ Parameters map[string]*AsyncAPIParameter

+ Replies map[string]*AsyncAPIOperationReply

+ ReplyAddresses map[string]*AsyncAPIReplyAddress

+ Schemas map[string]*AsyncAPISchema

+ SecuritySchemes map[string]*AsyncAPISecurityScheme

+ Tags map[string]*AsyncAPITag

+ type AsyncAPIContact struct

+ Email string

+ Name string

+ URL string

+ type AsyncAPICorrelationId struct

+ Description string

+ Location string

+ type AsyncAPIExternalDocs struct

+ Description string

+ URL string

+ type AsyncAPIInfo struct

+ Contact *AsyncAPIContact

+ Description string

+ ExternalDocs *AsyncAPIExternalDocs

+ License *AsyncAPILicense

+ Tags []*AsyncAPITag

+ TermsOfService string

+ Title string

+ Version string

+ type AsyncAPILicense struct

+ Name string

+ URL string

+ type AsyncAPIMessage struct

+ Bindings map[string]interface{}

+ CorrelationId *AsyncAPICorrelationId

+ Description string

+ Examples []interface{}

+ Headers *AsyncAPISchema

+ Name string

+ Payload *AsyncAPISchema

+ Ref string

+ Summary string

+ Tags []*AsyncAPITag

+ Title string

+ Traits []interface{}

+ type AsyncAPIOperation struct

+ Action string

+ Bindings map[string]interface{}

+ Channel map[string]string

+ Description string

+ ExternalDocs *AsyncAPIExternalDocs

+ Messages []map[string]string

+ Reply *AsyncAPIOperationReply

+ Security []map[string][]string

+ Summary string

+ Tags []*AsyncAPITag

+ Title string

+ Traits []interface{}

+ type AsyncAPIOperationReply struct

+ Address *AsyncAPIReplyAddress

+ Channel map[string]string

+ Messages []map[string]string

+ type AsyncAPIParameter struct

+ Default interface{}

+ Description string

+ Enum []interface{}

+ Examples []interface{}

+ Location string

+ type AsyncAPIReplyAddress struct

+ Description string

+ Location string

+ type AsyncAPISchema struct

+ AdditionalProperties *AsyncAPISchema

+ Default interface{}

+ Description string

+ Enum []interface{}

+ Example interface{}

+ Format string

+ Items *AsyncAPISchema

+ Properties map[string]*AsyncAPISchema

+ Ref string

+ Required []string

+ Title string

+ Type string

+ type AsyncAPISecurityScheme struct

+ Description string

+ In string

+ Name string

+ Scheme string

+ Type string

+ type AsyncAPIServer struct

+ Bindings map[string]interface{}

+ Description string

+ ExternalDocs *AsyncAPIExternalDocs

+ Host string

+ Pathname string

+ Protocol string

+ Security []map[string][]string

+ Summary string

+ Title string

+ Variables map[string]interface{}

+ type AsyncAPISpec struct

+ AsyncAPI string

+ Channels map[string]*AsyncAPIChannel

+ Components *AsyncAPIComponents

+ ID string

+ Info *AsyncAPIInfo

+ Operations map[string]*AsyncAPIOperation

+ Servers map[string]*AsyncAPIServer

+ type AsyncAPITag struct

+ Description string

+ ExternalDocs *AsyncAPIExternalDocs

+ Name string

type Generator

+ func (g *Generator) GenerateWebSocket(exchange, version, title, apiType string, servers map[string][]string) error

+ func (g *Generator) GenerateWebSocketEndpoints(exchange, version, apiType string, channels []wsParser.Channel) error

v0.2.0

May 5, 2025

Changes in this version

+ type Generator struct

+ func NewGenerator(outputDir string) *Generator

+ func (g *Generator) Generate(exchange, version, title, apiType string, servers []string) error

+ func (g *Generator) GenerateEndpoints(exchange, version, apiType string, endpoints []parser.Endpoint) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL