Skip to content

Commit f24e63d

Browse files
authored
Docs/add sns (#60)
1 parent 72f16f6 commit f24e63d

File tree

5 files changed

+9
-4
lines changed

5 files changed

+9
-4
lines changed

docs/behind-the-scenes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ From there, Springwolf forwards the message to the protocol specific producer.
1818

1919
## Plugins
2020
`springwolf-core` provides the base functionality to orchestrate the scanning and building of the AsyncAPI document.
21-
The different protocol (AMQP, Kafka, SQS) are supported through plugins.
21+
The different protocol (AMQP, Cloud-Stream, Kafka, SNS, SQS) are supported through plugins.
2222
These plugins are found through the Spring dependency injection functionality.
2323
When building own scanner plugins, your plugin will need to implement the `ChannelsScanner` interface.
2424

docs/configuration/configuration.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,8 @@ The following table contains additional properties that can be specified in the
7777
| `springwolf.plugin.kafka.publishing.enabled` | `false` | Allow (anyone) to produce Kafka messages from the UI. *Note that this has security implications* |
7878
| `springwolf.plugin.kafka.publishing.producer` | `null` | Configure the Kafka producer used to publish messages from the UI. Uses identical parameters as `spring.kafka.producer` |
7979
| `springwolf.plugin.kafka.scanner.kafka-listener.enabled` | `true` | Enable scanner to find methods annotated with `@KafkaListener`. |
80+
| **SNS** | | |
81+
| `springwolf.plugin.sns.publishing.enabled` | `false` | Allow (anyone) to produce SNS messages from the UI. *Note that this has security implications* |
8082
| **SQS** | | |
8183
| `springwolf.plugin.sqs.publishing.enabled` | `false` | Allow (anyone) to produce SQS messages from the UI. *Note that this has security implications* |
8284
| `springwolf.plugin.sqs.scanner.sqs-listener.enabled` | `true` | Enable scanner to find methods annotated with `@SqsListener`. |

docs/introduction/introduction.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ sidebar_position: 10
88
API Documentation is an important part of every project and product, but can be painful to maintain manually.
99
Spring Boot projects have great solutions for auto-generated documentation for REST APIs to overcome this pain (such as Springfox, or springdoc-openapi).
1010

11-
However, until now there were no solutions for asynchronous APIs (such as AMQP, Kafka, SQS, etc.). Springwolf aims to solve this and provides auto-generated documentation for asynchronous APIs built in Spring Boot.
11+
However, until now there were no solutions for asynchronous APIs (such as AMQP, Kafka, SNS, SQS, etc.). Springwolf aims to solve this and provides auto-generated documentation for asynchronous APIs built in Spring Boot.
1212

1313
Springwolf is compliant to [AsyncAPI](https://www.asyncapi.com), which brings the [swagger/OpenAPI](https://www.asyncapi.com/docs/tutorials/getting-started/coming-from-openapi) specification you know already from REST APIs into the world of event-driven architectures.
1414

@@ -20,6 +20,7 @@ Also, the demos of the
2020
[AMQP](https://amqp.demo.springwolf.dev),
2121
[Spring Cloud Stream](https://cloud-stream.demo.springwolf.dev),
2222
[Kafka](https://kafka.demo.springwolf.dev)
23+
[SNS](https://sns.demo.springwolf.dev)
2324
[SQS](https://sqs.demo.springwolf.dev)
2425
example projects are available.
2526

docs/introduction/supported-protocols.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ The following protocols are supported natively:
1616
| AMQP (RabbitMQ) | `@RabbitListener` | [`springwolf-amqp-example`][amqp] | ![Maven Central](https://img.shields.io/maven-central/v/io.github.springwolf/springwolf-amqp?color=green&label=springwolf-amqp&style=plastic) |
1717
| Cloud Functions | `@Bean` (functional interface) | [`springwolf-cloud-stream`][cloud-stream] | ![Maven Central](https://img.shields.io/maven-central/v/io.github.springwolf/springwolf-cloud-stream?color=green&label=springwolf-cloud-stream&style=plastic) |
1818
| Kafka | `@KafkaListener`, `@KafkaHandler` | [`springwolf-kafka-example`][kafka] | ![Maven Central](https://img.shields.io/maven-central/v/io.github.springwolf/springwolf-kafka?color=green&label=springwolf-kafka&style=plastic) |
19+
| SNS | | [`springwolf-sns-example`][sns] | ![Maven Central](https://img.shields.io/maven-central/v/io.github.springwolf/springwolf-sns?color=green&label=springwolf-sns&style=plastic) |
1920
| SQS | `@SqsListener` | [`springwolf-sqs-example`][sqs] | ![Maven Central](https://img.shields.io/maven-central/v/io.github.springwolf/springwolf-sqs?color=green&label=springwolf-sqs&style=plastic) |
2021

2122
Check out the example projects, which include a full `docker-compose` setup.
@@ -32,4 +33,5 @@ The protocols with native support come along with a `@_ProtocolName_Binding` ann
3233
[amqp]:https://github.com/springwolf/springwolf-core/tree/master/springwolf-examples/springwolf-amqp-example
3334
[cloud-stream]:https://github.com/springwolf/springwolf-core/tree/master/springwolf-examples/springwolf-cloud-stream-example
3435
[kafka]: https://github.com/springwolf/springwolf-core/tree/master/springwolf-examples/springwolf-kafka-example
36+
[sns]: https://github.com/springwolf/springwolf-core/tree/master/springwolf-examples/springwolf-sns-example
3537
[sqs]: https://github.com/springwolf/springwolf-core/tree/master/springwolf-examples/springwolf-sqs-example
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
dependencies {
22
// Provides the documentation API
3-
implementation 'io.github.springwolf:springwolf-kafka:0.14.0'
3+
implementation 'io.github.springwolf:springwolf-kafka:0.16.0'
44

55
// Provides the UI - optional (recommended)
6-
runtimeOnly 'io.github.springwolf:springwolf-ui:0.14.0'
6+
runtimeOnly 'io.github.springwolf:springwolf-ui:0.16.0'
77
}

0 commit comments

Comments
 (0)