Feature/property binding for docket configuration #123
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ithout the need to write code Co-authored-by: Timon Back <[email protected]>
…gle the possibility to produce on configured kafka instances Co-authored-by: Timon Back <[email protected]>
Co-authored-by: Timon Back <[email protected]>
Co-authored-by: Timon Back <[email protected]>
Use prefix in springwolf kafka plugin Add test for springwolf kafka plugin producer configuration switch Co-authored-by: Timon Back <[email protected]>
…f wie spring properties Set AMQP producer functionality to disabled as the new default Co-authored-by: Timon Back <[email protected]>
… application Co-authored-by: Timon Back <[email protected]>
…n and SpringWolfConfigProperties By default, the user-defined AsyncApiDocket is used. The application.properties are a fall-back, and possible recommended way in the future. Otherwise, an exception is thrown. Co-authored-by: sam0r040 <[email protected]>
Co-authored-by: sam0r040 <[email protected]>
Bean injection will only work, if the user defined a custom bean and it does not work, when the application.properties configuration is used. Co-authored-by: sam0r040 <[email protected]>
Co-authored-by: sam0r040 <[email protected]>
stavshamir
reviewed
Dec 21, 2022
| implementation 'org.springframework:spring-web' | ||
| implementation 'org.springframework.amqp:spring-rabbit' | ||
|
|
||
| implementation 'com.google.guava:guava:31.1-jre' | ||
|
|
||
| compileOnly 'org.projectlombok:lombok:1.18.4' | ||
| annotationProcessor 'org.projectlombok:lombok:1.18.4' | ||
| annotationProcessor 'org.springframework.boot:spring-boot-configuration-processor' |
There was a problem hiding this comment.
The annotation processor will create metadata files that can be used by IDEs to support code completion when work with spring configuration. This way users are not "blind" when they try to write spring configuration but get contextual help. I'm not sure how many IDEs support it, but Intellij has good support for it. This is what it looks like in Intellij for the sprinwolf-kafka-example project:
You can find the documentation here: https://docs.spring.io/spring-boot/docs/current/reference/html/configuration-metadata.html#appendix.configuration-metadata.annotation-processor
There was a problem hiding this comment.
Very cool, I didn't know that
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Springwolf AsyncApiDocket meta data can now be configured without manually creating a bean of AsyncApiDocket. All metadata can by provided with spring application porperties.
Together with #118 (Annotation for publisher and subscriber), it should now be possible to use springwolf without creating a AsyncApiDocket bean at all. Instead annotations and spring application properties can be used.
As a part of the change to use spring properties, a property to disable the producer functionality has been introduced to the kafka and amqp plugins. Although it is a breaking change, we decided to disable the producer functionality by default, because we see the functionality is potentially dangerous for users who are unaware of the feature and want to use springwolf in a production environment.
There is also another property to disable springwolf by spring configuration in springwolf core to support use cases where springwolf should be enabled on some deployment environments, although it should be disabled on others.