JDK 17 requires codegen 3.0.34+

adroste commented 2 years ago

https://github.com/1000kit/tkit-mp-restclient-plugin/blob/ad86d329c8ed3f67eefeea12d2a4835405725123/pom.xml#L52

This lib is not compatible with java 17 due to compile errors caused by jknack/handlebars which is a dependency of swagger-codegen. Similar issue: https://github.com/swagger-api/swagger-codegen/issues/10966

The erros are resolved with jknack/handlebars v4.3.0

Solutions:

Update to swagger-codegen 3.0.34+, see: https://mvnrepository.com/artifact/io.swagger.codegen.v3/swagger-codegen/3.0.34

Manually overwrite transitive dependency of swagger-codegen

<dependency>
<groupId>com.github.jknack</groupId>
<artifactId>handlebars</artifactId>
<version>4.3.0</version>
</dependency>

andrejpetras commented 2 years ago

@adroste could you try to use quarkus-openapi-generator instead of this plugin? https://github.com/quarkiverse/quarkus-openapi-generator

adroste commented 2 years ago

The quarkus-openapi-generator is working, but it's not perfect and definitely not a drop in replacement. As far as my research goes, these are the options for a quarkus based project:

Option 1: Quarkiverse OpenApi Generator

Lacks basic configuration options
- relevant issue: https://github.com/quarkiverse/quarkus-openapi-generator/issues/124
- No custom API class annotations
- configKey for microprofile is static and based on filename (+ ext) of spec file
  - e.g. tkit_apm_yaml
- Cannot specify the artifact/class names
  - generated API classes are named and split based on tags
    - e.g. “DefaultApi”, “V2Api”, “V3Api”
- configuration sits in application.properties
DTO properties are not pre-initialized (e.g. with empty lists)
- introduces breaking changes in unobvious locations
- example compared to tkit-mp-restclient-plugin:
  - tkit: private List<MyDTO> myList = new ArrayList<>();
  - quarkiverse: private List<MyDTO> myList = null;
Responses are converted directly to specific “ok”-response type
- no access to response status (like 200, 400, …)
- example compared to tkit-mp-restclient-plugin:
  - tkit:
    - Interface: Response myRequest(…);
    - Usage: myClient.myRequest(…).readEntity(ResponseDTO.class)
  - quarkiverse:
    - Interface: ResponseDTO myRequest(…)
    - Usage: myClient.myRequest(…)
other limitations (from docs):
- No reactive support
- Only Jackson support (<- no limitation for me, as it is what i want)
links:
- https://github.com/quarkiverse/quarkus-openapi-generator

Option 2: OpenAPITools OpenAPI Generator

A lot of valuable configuration options
No fitting template for quarkus (microprofile + jackson)
- issue: https://github.com/OpenAPITools/openapi-generator/issues/8015
- Java generator includes library type “microprofile” but generation does not support jackson and also includes dependencies we are not using (like apache cxf)
links:

Option 3: Swagger codegen

No microprofile template (issue: https://github.com/swagger-api/swagger-codegen/issues/9216 )

Option 4: tkit-mp-restclient-plugin

Requires updating the tkit-mp-restclient-plugin to Java 17
another custom plugin = another maintenance task <= therefore, it would be nice if we could replace it

ricardozanini commented 2 years ago

@adroste feel free to add suggestions/contribute to the quarkus-openapi-generator to enhance the compatibility you need for this project.

forszpanen commented 1 year ago

We were forced to update the plugin to jdk17 on our side. A few projects didn't work with Quarkus official plugin. e.g. problems with securityHeaders, customHeaders, oneOf hierarchy and beanParams required too much changes in a code. Some of those problems we resolved by making a change in official plugin. It would be great to have tkit plugins in java17 because a transition is very challenging.

andrejpetras commented 1 year ago

@forszpanen this project is deprecated, we do recommend to migrate to quarkus-openapi-generator

1000kit / tkit-mp-restclient-plugin

JDK 17 requires codegen 3.0.34+ #6