Add example for generating Java client using Maven plugin #21596
Conversation
This file contains hidden or 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
wing328
reviewed
Jul 21, 2025
| <modelPackage>com.example.model</modelPackage> | ||
| <invokerPackage>com.example.invoker</invokerPackage> | ||
| </configuration> | ||
| </plugin> |
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.
This PR adds a real-world usage example to the Maven plugin documentation, demonstrating how to generate a Java client from an OpenAPI YAML file during a Maven build.
What's included:-
A complete XML snippet showing how to configure openapi-generator-maven-plugin with Java client generation.
Clear usage of inputSpec, generatorName, apiPackage, modelPackage, and output fields.
Example placed right after the default usage block for better developer visibility.
This example aims to help Java developers integrate OpenAPI code generation into their Maven workflow more easily.
Let me know if any adjustments are needed.
TY