View all files | ||||
Automated documentation for event-driven applications built with Spring Boot
We are on discord for any question, discussion, request etc. Join us at https://discord.gg/HZYqd5RPTd
This project is inspired by Springfox. It documents asynchronous APIs using the AsyncAPI specification.
springwolf-ui adds a web UI, much like that of Springfox, and allows easy publishing of auto-generated payload examples.
Take a look at the Springwolf live demo and a generated AsyncAPI document.
springwolf.dev includes the quickstart guide and full documentation.
Springwolf exploits the fact that you already fully described your consumer endpoint (with listener annotations, such as @KafkaListener, @RabbitListener, @SqsListener, etc.) and generates the documentation based on this information.
Share API Schema DefinitionThe AsyncAPI conform documentation can be integrated into API hubs (like backstage) or be shared as a json/yaml file with others.
UI Based API TestingIn projects using asynchronous APIs, you may often find yourself needing to manually send a message to some topic, whether you are manually testing a new feature, debugging or trying to understand some flow.
Using the automatically generated example payload object as a suggestion, you can publish it to the correct channel with a single click.
Protocols not supported natively can still be documented using @AsyncListener and @AsyncPublisher annotation. More details in the documentation.
| AMQP | AMQP Example | ||
| AWS SNS | AWS SNS Example | ||
| AWS SQS | AWS SQS Example | ||
| Cloud Stream | Cloud Stream Example | ||
| JMS | JMS Example | ||
| Kafka | Kafka Example | ||
| STOMP (WebSocket) | STOMP Example |
| AsyncAPI implementation | ||
| Core | ||
| UI |
| AMQP Binding | ||
| AWS SNS Binding | ||
| AWS SQS Binding | ||
| Google PubSub Binding | ||
| JMS Binding | ||
| Kafka Binding | ||
| STOMP Binding |
| Common Model Converter | ||
| Generic Binding | ||
| Json Schema | ||
| Kotlinx Serialization Model Converter |
Comment in this PR to add your company and spread the word
Check out our CONTRIBUTING.md guide.
Testing SNAPSHOT versionAdd the following to the repositories closure in build.gradle:
Or add the repository to your pom.xml if you are using maven:
To test with local builds, run the publishToMavenLocal gradle task. The current version number is set in .env file.
Do not forget to add mavenLocal() to the repositories section.
Thanks goes to these wonderful people (emoji key):
To add yourself as a contributor, install the all-contributors CLI and run:
