Springwolf SNS Plugin

Automated documentation for Spring Boot application with AWS SNS (Simple Notification Service) consumers

Table Of Contents

• About
• Usage
  • Dependencies
• Verify
• Example Project

About

This plugin generates an AsyncAPI document from @SnsAsyncOperationBinding methods.

Usage

Add the following dependencies and configuration class to enable this plugin.

Dependencies

dependencies {
    // Provides the documentation API    
    implementation 'io.github.springwolf:springwolf-sns:<springwolf-version>'

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

Verify

If you have included the UI dependency, access it with the following url: localhost:8080/springwolf/asyncapi-ui.html. If not, try the following endpoint: localhost:8080/springwolf/docs.

Example Project

See springwolf-sns-example .