Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // ErrInvalidFileFormat is returned when using an invalid format for AsyncAPI specification. ErrInvalidFileFormat = fmt.Errorf("%w: invalid file format", extensions.ErrAsyncAPI) // ErrInvalidVersion is returned when the version is either unsupported or invalid. ErrInvalidVersion = fmt.Errorf("%w: unsupported/invalid version", extensions.ErrAsyncAPI) )
var SupportedVersions = []string{
"2.0.0",
"2.1.0",
"2.2.0",
"2.3.0",
"2.4.0",
"2.5.0",
"2.6.0",
"3.0.0",
}
SupportedVersions describe the asyncapi-codegen supported versions.
Functions ¶
func IsVersionSupported ¶
IsVersionSupported checks that the version is supported.
func ToV2 ¶
func ToV2(s Specification) (*asyncapiv2.Specification, error)
ToV2 returns an AsyncAPI specification V2 from interface, if compatible. Note: Before using this, you should make sure that parsed data is in version 2.
func ToV3 ¶
func ToV3(s Specification) (*asyncapiv3.Specification, error)
ToV3 returns an AsyncAPI specification V3 from interface, if compatible. Note: Before using this, you should make sure that parsed data is in version 3.
Types ¶
type Specification ¶
type Specification interface {
// MajorVersion returns the major version of the AsyncAPI specification.
MajorVersion() int
// Process processes all information in specification in order to link the
// references, apply the traits and generating other information for code
// generation.
//
// WARNING: this will alter the specification as you will find, by example,
// traits applied in the specification.
Process() error
}
Specification only contains common functions between each version. This should be casted to get all other functions, base on the version.
func FromFile ¶
func FromFile(path string) (Specification, error)
FromFile parses the AsyncAPI specification either from a YAML file or a JSON file.
NOTE: It returns the Specification with filled fields, but this doesn't link references, apply traits, etc. You have to call method `Process` for this.
func FromJSON ¶
func FromJSON(data []byte) (Specification, error)
FromJSON parses the AsyncAPI specification from a JSON file.
NOTE: It returns the Specification with filled fields, but this doesn't link references, apply traits, etc. You have to call method `Process` for this.
func FromYAML ¶
func FromYAML(data []byte) (Specification, error)
FromYAML parses the AsyncAPI specification from a YAML file.
NOTE: It returns the Specification with filled fields, but this doesn't link references, apply traits, etc. You have to call method `Process` for this.
Source Files
Directories