You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/configuration.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,7 +44,7 @@ There are 2 ways to configure springwolf:
44
44
45
45
It is recommended to structure the project such that all consumers and producers (classes containing listener/producer methods) are in the same package - it is not mandatory, and if they are scattered across multiple packages, just provide the highest in hierarchy package that contains all of them.
46
46
47
-
The base package will be scanned for classes containing `@Component` annotated classes (that includes `@Service` annotated classes) for methods annotated with `@KafkaListener`, `@RabbitListener`, `@AsyncSubscriber`, `@AsyncPublisher`, etc.
47
+
The base package will be scanned for classes containing `@Component` annotated classes (that includes `@Service` annotated classes) for methods annotated with `@KafkaListener`, `@RabbitListener`, `@AsyncListener`, `@AsyncPublisher`, etc.
Copy file name to clipboardExpand all lines: docs/documenting-consumers.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,23 +10,23 @@ Sometimes projects are configured in a way that makes Springwolf unable to autom
10
10
For these use-cases, Springwolf provides additional ways to explicitly add them to the generated document.
11
11
12
12
To document consumers, either:
13
-
- add the `@AsyncSubscriber` annotation or
13
+
- add the `@AsyncListener` annotation or
14
14
- declare the `ConsumerData` object as part of the `AsyncApiDocket` or
15
15
- rely on the auto-detection of `@KafkaListener`, `@RabbitListener`
16
16
17
-
You are free to use all options together. Per channel and operation, first `ConsumerData` is used, then `@AsyncSubscriber` and last the auto-detected annotations.
17
+
You are free to use all options together. Per channel and operation, first `ConsumerData` is used, then `@AsyncListener` and last the auto-detected annotations.
18
18
19
-
## Option 1: `@AsyncSubscriber`
19
+
## Option 1: `@AsyncListener`
20
20
21
-
The `@AsyncSubscriber` annotation is added to the method of the listeners and extracts the payload from its arguments.
21
+
The `@AsyncListener` annotation is added to the method of the listeners and extracts the payload from its arguments.
22
22
Additional fields can be documented.
23
23
24
24
The protocol operation binding is configured via `@AmqpAsyncOperationBinding` or `@KafkaAsyncOperationBinding`, which has to be on the same method.
25
25
26
26
Below is an example to demonstrate the annotation:
27
27
```java
28
28
@KafkaListener
29
-
@AsyncSubscriber(operation=@AsyncOperation(
29
+
@AsyncListener(operation=@AsyncOperation(
30
30
channelName="example-consumer-topic",
31
31
description="Optional. Customer uploaded an example payload",
0 commit comments