Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use OpenAPI tag names to generage Java API interfaces #20

Merged
merged 1 commit into from
Mar 25, 2024

Conversation

groldan
Copy link
Member

@groldan groldan commented Mar 25, 2024

Add the <useTags>true</useTags> configuration option to the openapi-generator-maven-plugin, so it generates Java API interfaces based on the tags of each operation instead of using the URI paths.

This leads to the following refactoring of classes:

CollectionsApi -> DataApi
DefaultApi -> CapabilitiesApi

Additionally, some methods from the DataApi are moved to the CapabilitiesApi, as they're annotated with the Capabilities tag in the OpenAPI definition.

Add the `<useTags>true</useTags>` configuration option to the
`openapi-generator-maven-plugin`, so it generates Java API interfaces
based on the tags of each operation instead of using the URI paths.

This leads to the following refactoring of classes:

`CollectionsApi` -> `DataApi`
`DefaultApi` -> `CapabilitiesApi`

Additionally, some methods from the `DataApi` are moved to the
`CapabilitiesApi`, as they're annotated with the `Capabilities` tag in
the OpenAPI definition.
@groldan groldan requested a review from pmauduit March 25, 2024 13:05
Copy link
Member

@pmauduit pmauduit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@pmauduit pmauduit merged commit 9d779c4 into main Mar 25, 2024
1 check passed
@pmauduit pmauduit deleted the use_tags_for_api_names branch March 25, 2024 13:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants