Add example configuration for springdoc-openapi-gradle-plugin #134
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
sam0r040
force-pushed
the
feature/example_configuration_for_springdoc-openapi-gradle-plugin
branch
from
09420a9 to
355aee4
Compare
timonback
reviewed
Jan 21, 2023
| String expectedWithoutServersKafkaUrlPatch = IOUtils.toString(expectedStream, StandardCharsets.UTF_8); | ||
| String expected = expectedWithoutServersKafkaUrlPatch.replace("kafka:29092", "localhost:29092"); | ||
|
|
||
| InputStream actualStream = this.getClass().getResourceAsStream("/openapi-generated.json"); |
There was a problem hiding this comment.
Great. Learning for me, the build folder is also scanned for resources
| import java.io.InputStream; | ||
| import java.nio.charset.StandardCharsets; | ||
|
|
||
| public class OpenApiGeneratorTest { |
There was a problem hiding this comment.
Maybe put a comment that this test is linked to the build.gradle configuration and plugin?
Just to make the link more obvious
There was a problem hiding this comment.
I tried to put a comment to explain the connection between the gradle configuration and this test. Does it help?
sam0r040
force-pushed
the
feature/example_configuration_for_springdoc-openapi-gradle-plugin
branch
from
355aee4 to
684d7fa
Compare
…ngwolf-kafka-example, use springdoc-openapi-gradle-plugin to generate the api spec before test execution and added a test to ensure that the plugin still works for springwolf
sam0r040
force-pushed
the
feature/example_configuration_for_springdoc-openapi-gradle-plugin
branch
from
684d7fa to
1ce489c
Compare
timonback
approved these changes
Jan 23, 2023
|
Good addition @sam0r040 , thanks for reviewing @timonback |
This was referenced Jan 25, 2023
timonback
referenced
this pull request
in timonback/springwolf-core
Aug 7, 2023
i.e. A MapSchema is an object, but doesn't have properties
timonback
referenced
this pull request
in timonback/springwolf-core
Aug 7, 2023
i.e. A MapSchema is an object, but doesn't have properties
timonback
added a commit
that referenced
this pull request
Aug 18, 2023
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.
Added an example configuration for springdoc-openapi-gradle-plugin to the springwolf-kafka-example to demonstrate how it can be used.
To test and ensure that the plugin still works for springwolf, I also added:
I'm not super happy with the testing part, because there is no way to ignore exception from springdoc-openapi-gradle-plugin. That means that if there is a problem with the application start and the plugin can not get the spec, the build will fail before the tests are executed. If that is not acceptable we can discuss more complex options ie moving this test into its own gradle task that is executed after the tests.