- Notifications
You must be signed in to change notification settings - Fork1
AsyncAPI codegen tool for Go. Supports most of AsyncAPI features, many protocols (and pluggable client for each one), reference resolver and more!
License
bdragon300/go-asyncapi
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
go-asyncapi is the codegen tool that generates the boilerplate Go code fromAsyncAPIdocuments.It supports most of the AsyncAPI features, such as messages, channels, servers, bindings, correlation ids, etc.
AsyncAPI is a specification for defining APIs for event-driven architectures. TheAsyncAPI document describes the messages, channels, servers, and other entities that the systems in event-drivenarchitecture use to communicate with each other.
The generated code is not only just a bunch of stubs, it contains the abstract logic sufficient to send andreceive data through channels with no external dependencies except the standard Go library.So, no extra features are inside beyond what is necessary (such as logging, metrics, etc.) --it's up to you what you use in your project.
The code is also modular, so many generated objects can be used separately or be reused from another location.
Finally,go-asyncapi provides a pluggableimplementation for every supported protocol — minimal client codebased on one of popular libraries for that protocol. This is convenient for simple needs or may be used as quickstartfor your own implementation.
Full list of features available onFeatures page.
Batteries included, but removable :)
go install github.com/bdragon300/go-asyncapi/cmd/go-asyncapi@latest
go-asyncapi usesSemantic Versioning for versioning. For example,1.4.0.
Releasing apatch version contains only bug fixes and minor improvements. You won't need to regenerate the code afterupgrading the tool. E.g.1.4.0 → 1.4.1.
Releasing aminor version means that the generated code may be affected, but without breaking changes. You may need toregenerate the code. E.g.1.4.0 → 1.5.0.
Major version release typically introduces the breaking changes. You may need to regenerate the code, to fix yourprojects that uses it or to change the tool command line. E.g.1.4.0 → 2.0.0.
Why do I need another third-party codegen tool? We have already theofficial generator
Long story short: this one provides more features and protocols, and it has written in Go.
The official generator is quite specific for many cases.At the moment, it produces the Go code bound with the Watermill framework, but not everyone uses the Watermill intheir projects.Also, it supports only the AMQP protocol.
Instead,go-asyncapi:
- produces framework-agnostic code with the standard Go library as single dependency.
- supports moreprotocols and more specific AsyncAPI entities, such asbindings, correlation ids, server variables, etc.
- contains the pluggable minimal clients for all supported protocols based on popular libraries.
- written in Go, so no need to have node.js or Docker or similar tools to run the generator.
Another reason is that I don't know JavaScript well. And I'm not sure that if we want to support all AsyncAPI features,the existing template would not be rewritten from the ground.
go-asyncapi has many ways to customize the generated code, see the command line flags andx- fields description.
However, unlike the more common approach for other codegen tools that use templates, thego-asyncapi uses thejennifer library. This approach is less customizable by user, but moreflexible. It's easier to make support of AsyncAPI specification more complete this way and to deal with complexdocuments with plenty of interlinked objects.
But still, user template support in some reduced form is a planned feature.
About
AsyncAPI codegen tool for Go. Supports most of AsyncAPI features, many protocols (and pluggable client for each one), reference resolver and more!