Quickstart

In just 3 steps:

1. Add dependency
2. Configure properties (optional)
3. Start application & View the docs

Let's get started!

The following instructions are for Kafka services - other protocols are almost the same.

1. Add dependency

Add the following dependencies:

Groovy

dependencies {
    // Provides the documentation API
    implementation 'io.github.springwolf:springwolf-kafka:2.0.0'

    // Provides the UI - optional (recommended)
    runtimeOnly 'io.github.springwolf:springwolf-ui:2.0.0'
}

Maven

<dependencies>
    <!-- Provides the documentation API -->
    <dependency>
        <groupId>io.github.springwolf</groupId>
        <artifactId>springwolf-kafka</artifactId>
        <version>2.0.0</version>
    </dependency>
    <!-- Provides the UI - optional (recommended) -->
    <dependency>
        <groupId>io.github.springwolf</groupId>
        <artifactId>springwolf-ui</artifactId>
        <version>2.0.0</version>
    </dependency>
</dependencies>

Latest version is

2. Configure properties (optional)

To customize, add the following to your application.properties:

springwolf.docket.info.title=${spring.application.name}

springwolf.docket.servers.kafka-server.protocol=kafka
springwolf.docket.servers.kafka-server.host=${spring.kafka.bootstrap-servers:localhost:29092}

3. Start application & View the docs

Start the application and open the URLs in your browser:

• AsyncAPI: <host>:<port>/springwolf/docs
  • Use the Accept: application/yaml header to request yaml instead of json
• UI: <host>:<port>/springwolf/asyncapi-ui.html

If you configured a different context path in your application, make sure to prepend it to Springwolf URLs: <host>:<port>/<context-path>/springwolf/asyncapi-ui.html

4. Next steps

• Kickstart Your AsyncAPI journey with Springwolf at AsyncAPI Webinar 2025
• AsyncAPI and Springwolf presentation at Spring I/O 2024
• Read an elaborated tutorial on Baeldung at https://www.baeldung.com/java-spring-doc-asyncapi-springwolf
• Check out the supported protocols and example projects
• Dive deeper on the next pages