[Microprofile] Add option to use tags a client keys and server generator #16673

kiwi-oss · 2023-09-26T12:29:07Z

This adds two features for Microprofile.

One is the configKeyFromClassName option that allows naming the configuration key of the @RegisterRestClient annotation after the annotated API interface.

The effect can be seen in the interfaces under samples/client/petstore/java/microprofile-rest-client/src/main/java/org/openapitools/client/api. Compare to those under e.g. samples/client/petstore/java/microprofile-rest-client-3.0-jackson/src/main/java/org/openapitools/client/api where a fixed key is used.

The other addition is a server generator which has the feature of properly handling cases where multiple HTTP 2xx responses are defined, see GET /pet/findByTags in modules/openapi-generator/src/test/resources/3_0/petstore-multiple-2xx-responses.yaml.

The various 2xx responses can return different things, e.g. 200 the whole resource, 204 nothing, 206 a partial resource and so on. Therefore, the return type of the related server interface method has to return a generic response type. This can be seen for findPetsByTags in samples/server/petstore/microprofile/src/main/java/org/openapitools/server/api/PetApi.java.

@bbdouglas @sreeshas @jfiala @lukoyanov @cbornet @jeff9finger @karismann @Zomzog @lwlee2608 @martin-mfg

PR checklist

Read the contribution guidelines.
Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
Run the following to build the project and update samples:
```
./mvnw clean package 
./bin/generate-samples.sh ./bin/configs/*.yaml
./bin/utils/export_docs_generators.sh
```
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
For Windows users, please run the script in Git BASH.
File the PR against the correct branch: master (upcoming 7.1.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

…erfaces using Mutiny in Java Microprofile library

…roprofile-improvements # Conflicts: # samples/openapi3/client/petstore/spring-stubs-skip-default-interface/src/main/java/org/openapitools/model/ModelApiResponse.java # samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/CatAllOf.java # samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/DogAllOf.java # samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/HasOnlyReadOnly.java # samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/Model200Response.java # samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/ModelApiResponse.java # samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/ModelList.java # samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/ModelReturn.java # samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/SpecialModelName.java # samples/openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/model/ModelApiResponse.java # samples/server/petstore/spring-mvc-default-value/src/main/java/org/openapitools/api/TestHeadersApi.java # samples/server/petstore/spring-mvc-default-value/src/main/java/org/openapitools/api/TestQueryParamsApi.java # samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/api/AnotherFakeApi.java # samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/api/FakeApi.java # samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/api/FakeClassnameTestApi.java # samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/api/PetApi.java # samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/api/StoreApi.java # samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/api/UserApi.java # samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/model/BigCatAllOf.java # samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/model/CatAllOf.java # samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/model/DogAllOf.java # samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/model/EnumTest.java # samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/model/FormatTest.java # samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/model/HasOnlyReadOnly.java # samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/model/Model200Response.java # samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/model/ModelList.java # samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/model/ModelReturn.java # samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/model/SpecialModelName.java # samples/server/petstore/spring-mvc-j8-async/src/main/resources/openapi.yaml # samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/api/AnotherFakeApi.java # samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/api/FakeApi.java # samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/api/FakeClassnameTestApi.java # samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/api/PetApi.java # samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/api/StoreApi.java # samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/api/UserApi.java # samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/model/BigCatAllOf.java # samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/model/CatAllOf.java # samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/model/DogAllOf.java # samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/model/EnumTest.java # samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/model/FormatTest.java # samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/model/HasOnlyReadOnly.java # samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/model/Model200Response.java # samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/model/ModelList.java # samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/model/ModelReturn.java # samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/model/SpecialModelName.java # samples/server/petstore/spring-mvc-j8-localdatetime/src/main/resources/openapi.yaml # samples/server/petstore/spring-mvc-no-nullable/.openapi-generator/VERSION # samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/api/AnotherFakeApi.java # samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/api/FakeApi.java # samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/api/FakeClassnameTestApi.java # samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/api/PetApi.java # samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/api/StoreApi.java # samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/model/BigCatAllOf.java # samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/model/CatAllOf.java # samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/model/DogAllOf.java # samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/model/EnumTest.java # samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/model/FormatTest.java # samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/model/HasOnlyReadOnly.java # samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/model/Model200Response.java # samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/model/ModelApiResponse.java # samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/model/ModelReturn.java # samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/model/SpecialModelName.java # samples/server/petstore/spring-mvc-no-nullable/src/main/resources/openapi.yaml # samples/server/petstore/spring-mvc-spring-pageable/.openapi-generator/VERSION # samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/api/AnotherFakeApi.java # samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/api/FakeApi.java # samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/api/FakeClassnameTestApi.java # samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/api/PetApi.java # samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/api/UserApi.java # samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/model/CatAllOf.java # samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/model/DogAllOf.java # samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/model/EnumTest.java # samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/model/FormatTest.java # samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/model/HasOnlyReadOnly.java # samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/model/Model200Response.java # samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/model/ModelApiResponse.java # samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/model/ModelList.java # samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/model/ModelReturn.java # samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/model/SpecialModelName.java # samples/server/petstore/spring-mvc-spring-pageable/src/main/resources/openapi.yaml # samples/server/petstore/spring-mvc/.openapi-generator/VERSION # samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/AnotherFakeApi.java # samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/FakeApi.java # samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/FakeClassnameTestApi.java # samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/StoreApi.java # samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/UserApi.java # samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/BigCatAllOf.java # samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/CatAllOf.java # samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/DogAllOf.java # samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/EnumTest.java # samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/FormatTest.java # samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/HasOnlyReadOnly.java # samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/Model200Response.java # samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/ModelApiResponse.java # samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/ModelList.java # samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/ModelReturn.java # samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/SpecialModelName.java # samples/server/petstore/spring-mvc/src/main/resources/openapi.yaml

…er-generator

This reverts commit b5bcbde.

Some other generators than those for Micronaut don't seem to be able to handle this case, so we don't add it to the general pet store document.

…er-generator

wing328 · 2023-10-03T10:51:10Z

https://github.com/OpenAPITools/openapi-generator/actions/runs/6312654633/job/17293794844?pr=16673

looks like there're some unresolved merge conflicts

do you minding merging the latest master into your branch and regenerating the samples?

…er-generator

kiwi-oss · 2023-10-09T20:53:46Z

Done. Sorry for the delay, I was on holidays

kiwi-oss · 2023-10-16T13:32:58Z

@wing328 There is still some failure, but it seems to me that it's not related to my changes because it's in some JavaScript code.
Can you advise how to proceed with this?

…er-generator

wing328 · 2024-04-24T07:00:42Z

@kiwi-oss thanks for the PR. please PM me via Slack when you've to further discuss this.

https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g

wing328 · 2024-04-25T03:40:33Z

bin/configs/java-microprofile-server-multiple-2xx-responses.yaml

@@ -0,0 +1,8 @@
+generatorName: microprofile


can we name the generator as "java-microprofile" instead following the convention of other java server generators?

wing328 · 2024-04-25T03:47:21Z

bin/configs/java-microprofile-server-multiple-2xx-responses.yaml

@@ -0,0 +1,8 @@
+generatorName: microprofile
+outputDir: samples/server/petstore/microprofile


please add the new folder to .github/workflows/samples-java-server-jdk8.yaml so that CI will test it moving forward

wing328 · 2024-04-25T03:49:49Z

...pi-generator/src/main/java/org/openapitools/codegen/languages/MicroprofileServerCodegen.java

+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class MicroprofileServerCodegen extends JavaClientCodegen {


personally I would suggest NOT to extend a java server with JavaClientCodegen as most options available in JavaClientCodegen won't make sense in the server generator if I understand it correctly.

The java generator, using the microprofile library, generates an interface that could be used for either client or server.

This is what is being extended. I understand that it seems odd to have a server code generator inherit from a client generator. But we would have to re write the functionality of the java generator.

Do you have a suggestion of how to proceed with this?
Or perhaps it could be listed as a MicroprofileClientCodegen because it could be used for either client of server

right seems odd but to me but it's not a showstopper.

if this way is a good starting point to add the server generator for microprofile, i'm totally ok with that.

…ml so that CI will test it moving forward

...penapi-generator/src/main/resources/META-INF/services/org.openapitools.codegen.CodegenConfig

wing328 · 2024-04-29T18:09:24Z

can you please review the test failure when you've time? https://github.com/OpenAPITools/openapi-generator/actions/runs/8880595750/job/24389070322?pr=16673

oscarobr · 2024-04-30T06:45:06Z

can you please review the test failure when you've time? https://github.com/OpenAPITools/openapi-generator/actions/runs/8880595750/job/24389070322?pr=16673

This is caused by a mixing of Junit 4 and Junit 5, and unsatisfied dependencies. It seems this was introduced in 7.5.0 and that there have been issues raised for it /issues/18465

oscarobr · 2024-04-30T09:08:28Z

can you please review the test failure when you've time? https://github.com/OpenAPITools/openapi-generator/actions/runs/8880595750/job/24389070322?pr=16673

This is caused by a mixing of Junit 4 and Junit 5, and unsatisfied dependencies. It seems this was introduced in 7.5.0 and that there have been issues raised for it /issues/18465

The java microprofile library does not build generate correctly, as the microprofile/pom.mustache does not contain the junit 5 dependencies. I noticed that when regenerating the samples it does not modify these existing samples, so the issue has not been uncovered. I have switched the samples generation to junit 4 to resolve my failing build, but there should be a larger fix for the microprofile library

wing328 · 2024-05-06T06:44:13Z

can you please review the test failure in https://github.com/OpenAPITools/openapi-generator/actions/runs/8892195364/job/24617679907?pr=16673 when you've time?

oscarobr · 2024-05-06T06:54:54Z

can you please review the test failure in https://github.com/OpenAPITools/openapi-generator/actions/runs/8892195364/job/24617679907?pr=16673 when you've time?

done

wing328 · 2024-05-06T11:56:01Z

thanks for the PR. all tests passed. if no one has further feedback, I'll merge it tomorrow.

cc @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @martin-mfg (2023/08)

pravussum and others added 19 commits February 9, 2022 12:08

[Java/Microprofile] Add support for Jackson serialization & async int…

3abefee

…erfaces using Mutiny in Java Microprofile library

Regenerate samples & docs

7983f0d

Add server generator

e41a2ff

Update client to set configKey by classname

09e441f

Remove debug remains and comments

a7b4f70

Merge remote-tracking branch 'upstream/master' into microprofile-serv…

9ef4f6a

…er-generator

Adapt method override to upstream changes

7e8fd05

Regenerate samples

b5bcbde

Merge remote-tracking branch 'upstream/master' into microprofile-serv…

5429144

…er-generator

Revert "Regenerate samples"

095d22f

This reverts commit b5bcbde.

Move additional 2xx response to dedicated OpenAPI document

60475f0

Some other generators than those for Micronaut don't seem to be able to handle this case, so we don't add it to the general pet store document.

Make filename consistent with other files in the folder

58655da

Regenerate Microprofile client and server samples

f9138a2

Merge remote-tracking branch 'upstream/master' into microprofile-serv…

6219586

…er-generator

Merge remote-tracking branch 'upstream/master' into microprofile-serv…

e66f96b

…er-generator

Merge remote-tracking branch 'upstream/master' into microprofile-serv…

aa89d82

…er-generator

Generate samples

160831e

Update documentation

b72f09b

wing328 added Client: Java Enhancement: General labels Oct 1, 2023

wing328 added this to the 7.1.0 milestone Oct 1, 2023

kiwi-oss added 2 commits October 9, 2023 22:35

Merge remote-tracking branch 'upstream/master' into microprofile-serv…

9db4a4e

…er-generator

Generate samples

ce52f7c

kiwi-oss added 2 commits October 18, 2023 15:35

Remove left-over *.orig files from Git merges

ac0d143

Merge remote-tracking branch 'upstream/master' into microprofile-serv…

f2284bd

…er-generator

wing328 removed this from the 7.1.0 milestone Nov 13, 2023

Merge branch 'OpenAPITools:master' into microprofile-server-generator

a58b998

oscarobr force-pushed the microprofile-server-generator branch from 63d1367 to a58b998 Compare April 24, 2024 09:24

oscarobr and others added 2 commits April 24, 2024 11:24

Merge branch 'OpenAPITools:master' into microprofile-server-generator

f16fba2

Regenerated samples

e564440

wing328 reviewed Apr 25, 2024

View reviewed changes

oscarobr added 2 commits April 25, 2024 14:53

changed generator name to "java-microprofile"

707545b

added the new folder to .github/workflows/samples-java-server-jdk8.ya…

8e25428

…ml so that CI will test it moving forward

kiwi-oss requested a review from jimschubert as a code owner April 25, 2024 12:53

wing328 reviewed Apr 25, 2024

View reviewed changes

...penapi-generator/src/main/resources/META-INF/services/org.openapitools.codegen.CodegenConfig Outdated Show resolved Hide resolved

oscarobr and others added 4 commits April 25, 2024 15:13

Renamed JavaMicroprofileServerCodegen.java

db381f1

regenerated samples

74f6b04

only enable configKeyFromClassName if configKey is not set

2b6f9b3

Merge branch 'OpenAPITools:master' into microprofile-server-generator

f123bab

Updated documentation

a066de5

Change samples to use junit 4

e82cac2

Fix junit 4 test classes

1fa87ec

oscarobr and others added 3 commits May 6, 2024 09:57

Merge branch 'OpenAPITools:master' into microprofile-server-generator

f9ce785

run ensure up-to-date script

31f8340

fix kotlin test errors

f8c20b6

wing328 merged commit dec8a43 into OpenAPITools:master May 7, 2024
116 checks passed

wing328 added this to the 7.6.0 milestone May 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Microprofile] Add option to use tags a client keys and server generator #16673

[Microprofile] Add option to use tags a client keys and server generator #16673

kiwi-oss commented Sep 26, 2023 •

edited

Loading

wing328 commented Oct 3, 2023

kiwi-oss commented Oct 9, 2023

kiwi-oss commented Oct 16, 2023

wing328 commented Apr 24, 2024

wing328 Apr 25, 2024

oscarobr Apr 25, 2024

wing328 Apr 25, 2024

oscarobr Apr 25, 2024

wing328 Apr 25, 2024

oscarobr Apr 25, 2024

wing328 Apr 25, 2024

wing328 commented Apr 29, 2024

oscarobr commented Apr 30, 2024

oscarobr commented Apr 30, 2024

wing328 commented May 6, 2024

oscarobr commented May 6, 2024

wing328 commented May 6, 2024

		@@ -0,0 +1,8 @@
		generatorName: microprofile
		outputDir: samples/server/petstore/microprofile

[Microprofile] Add option to use tags a client keys and server generator #16673

[Microprofile] Add option to use tags a client keys and server generator #16673

Conversation

kiwi-oss commented Sep 26, 2023 • edited Loading

PR checklist

wing328 commented Oct 3, 2023

kiwi-oss commented Oct 9, 2023

kiwi-oss commented Oct 16, 2023

wing328 commented Apr 24, 2024

wing328 Apr 25, 2024

Choose a reason for hiding this comment

oscarobr Apr 25, 2024

Choose a reason for hiding this comment

wing328 Apr 25, 2024

Choose a reason for hiding this comment

oscarobr Apr 25, 2024

Choose a reason for hiding this comment

wing328 Apr 25, 2024

Choose a reason for hiding this comment

oscarobr Apr 25, 2024

Choose a reason for hiding this comment

wing328 Apr 25, 2024

Choose a reason for hiding this comment

wing328 commented Apr 29, 2024

oscarobr commented Apr 30, 2024

oscarobr commented Apr 30, 2024

wing328 commented May 6, 2024

oscarobr commented May 6, 2024

wing328 commented May 6, 2024

kiwi-oss commented Sep 26, 2023 •

edited

Loading