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
The `base-package` is scanned for listeners and publishers.
19
+
20
+
In detail, Springwolf searches for `@Component` annotated classes (that includes `@Service` annotated classes) with methods annotated with `@AsyncListener`, `@AsyncPublisher`, `@JmsListener`, `@KafkaListener`, `@MessageMapping`, `@RabbitListener`, `@SqsListener`, etc.
21
+
Also, `@Configuration` classes are scanned for `@Bean` classes containing the previously mentioned annotations.
15
22
16
23
It's recommended to structure the project such that all consumers and producers (classes containing listener/producer methods) are in the same package - it's not mandatory, and if they're scattered across multiple packages, just provide the highest in hierarchy package that contains all classes.
17
24
18
25
You can add multiple base packages separated by commas.
19
26
20
-
The `base-package` will be scanned for classes containing `@Component` annotated classes (that includes `@Service` annotated classes) for methods annotated with `@JmsListener`, `@KafkaListener`, `MessageMapping`, `@RabbitListener`, `@SqsListener`, `@AsyncListener`, `@AsyncPublisher`, etc.
21
-
`@Configuration` classes are scanned for `@Bean` containing the previously mentioned annotations as well.
22
-
23
-
### `Info` (required)
27
+
### `Info`
24
28
25
29
The `Info` object provides metadata about the API (see [Info Object](https://www.asyncapi.com/docs/reference/specification/v3.0.0#infoObject)).
26
30
27
31
All provided fields will be present in the generated document, but not all will be displayed in the UI.
28
32
29
-
### `Servers` (required)
33
+
### `Servers`
30
34
31
35
The `Server` object provides metadata to help the reader understand the protocol, version, login details and more (see [AsyncAPI Server Object](https://www.asyncapi.com/docs/reference/specification/v3.0.0#serversObject)).
32
36
Any name (`kafka-server` in the example) can be chosen.
@@ -35,7 +39,7 @@ An AsyncAPI document can contain more than one server, but it's not common.
35
39
36
40
As with the `Info` object, all provided fields will be present in the generated document, but not all will be displayed in the UI.
37
41
38
-
## Additional `application.properties`
42
+
## Additional Properties
39
43
40
44
The following table contains additional properties that can be specified in the `application.properties` file:
41
45
@@ -81,7 +85,7 @@ The following table contains additional properties that can be specified in the
81
85
The AsyncAPI specification allows the definition of additional data fields to extend the
82
86
specification at certain points (see [Specification Extensions](https://www.asyncapi.com/docs/reference/specification/v3.0.0#specificationExtensions) ).
83
87
84
-
Extension Fields may be added to `Info`, `Contact`, `License` and `Server` objects both via`application.properties`.
88
+
Extension Fields may be added to `Info`, `Contact`, `License` and `Server` objects in`application.properties`.
85
89
Every custom extension field must begin with `x-`, for example `x-internal-id` (see sample configurations above).
Copy file name to clipboardExpand all lines: docs/configuration/customizing.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
@@ -69,7 +69,7 @@ public class TagCustomizer implements OperationCustomizer {
69
69
70
70
The `DefaultAsyncApiSerializerService` is responsible for serializing the AsyncAPI document into a `String` for the Controller.
71
71
72
-
Use `DefaultAsyncApiSerializerService#getJsonObjectMapper()` and `DefaultAsyncApiSerializerService#getYamlObjectMapper()` to customize the `ObjectMapper`.
72
+
Use `DefaultAsyncApiSerializerService#getJsonMapper()` and `DefaultAsyncApiSerializerService#getYamlMapper()` to customize the `ObjectMapper` (will change with migration to Jackson 3).
0 commit comments