Logo Springwolf

Automated documentation for event-driven applications built with Spring Boot

Last Version GitHub commits since latest release (by SemVer including pre-releases) License

springwolf-core springwolf-asyncapi springwolf-ui springwolf-plugins springwolf-addons

We are on discord for any question, discussion, request etc. Join us at https://discord.gg/HZYqd5RPTd

• About
• Demo & Documentation
• Why You Should Use Springwolf
• Usage & Example
• Who's Using Springwolf
• How To Participate
• Contributors

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.

Protocols not supported natively can still be documented using @AsyncListener and @AsyncPublisher annotation. More details in the documentation.

• 2bPrecise
• aconium
• Alten Italia
• b.well Connected Health
• DGARNE - Public Service of Wallonia (BE)
• Eclipse xpanse
• ITA-Social-Projects
• LVM Versicherung
• PagoPA
• OTTO
• OTTO Payments
• Teambank

Comment in this PR to add your company and spread the word

Check out our CONTRIBUTING.md guide.

repositories {
 // ...
 maven {
 url "https://central.sonatype.com/repository/maven-snapshots/" // build.gradle
 // url = uri("https://central.sonatype.com/repository/maven-snapshots/") // build.gradle.kts
 }
}

<repositories>
 <repository>
 <id>oss-sonatype</id>
 <name>oss-sonatype</name>
 <url>https://central.sonatype.com/repository/maven-snapshots/</url>
 <snapshots>
 <enabled>true</enabled>
 </snapshots>
 </repository>
</repositories>

Thanks goes to these wonderful people (emoji key):

To add yourself as a contributor, install the all-contributors CLI and run:

1. npx all-contributors-cli check
2. npx all-contributors-cli add <username> code
3. npx all-contributors-cli generate