Code generators

[pvdbosch]

In this discussion, you can share your ideas or experiences about code generators (like openapi-generator or swagger-codegen) that you use it to generate server or client code from OpenAPI files that follow the REST guide.

[pvdbosch]

This thread is meant as a continuation of the discussions on OpenAPI code generators in issue #25 .

[pvdbosch]

About the confusion around typeMappings/schemaMappings/importMappings mentioned in #25 :

• use schemaMappings if you want to map to your own model class instead of generating one (we've used it and seems to work)
• importMappings still generates a class. It seems to have been designed for something else, though not clear to me for which use case. It's listed in the documentation under "bring your own model" but that seems to be incorrect.
• typeMappings can be used to modify the name of the generated class, to something else then the one in the OpenAPI file. There are similar configurations to modify parameter names, property names, inline types, etc.

[pvdbosch]

Generated classes for OpenAPI enums can be difficult to map to domain classes in Java because their enum values aren't generated in UPPER_SNAKE_CASE, but UPPERCASE.

There's a related open issue: OpenAPITools/openapi-generator#4837 ; with workaround using "x-enum-varnames".
Anyone also experiencing this difficulty; are there other solutions?

[jpraet]

@pvdbosch this issue has been addressed in the latest openapi-generator 7.7.0.

[jpraet]

The upgrade from openapi-generator 7.1.0 to 7.2.0 is causing some problems for us (using the jax-rs generator).

It places @Valid bean validations on generic type parameters. e.g. private @Valid List<@Valid Partner> items;.
This annotation location is only supported in Bean Validation 2.0 so is causing issues for older Java EE 7 applications.

Furthermore, in more recent Java EE 8 applications on JBoss it also seems to be causing issues:

WELD-001503: Bean class which has interceptors cannot be declared final: class be.fgov.kszbcss.tad.admin.rest.model.PartnersRest$PartnersRestBuilderImpl

[jpraet]

See OpenAPITools/openapi-generator#17874 and OpenAPITools/openapi-generator#17875.

[jpraet]

OpenAPITools/openapi-generator#17875 has been addressed in latest openapi-generator 7.7.0.

Some migration notes:

• Since 7.3.0 operations and models that are marked as x-internal: true are skipped during code generation.
  To disable this, you need to configure <openapiNormalizer>REMOVE_X_INTERNAL=true</openapiNormalizer>.
  Yes, you need to set REMOVE_X_INTERNAL to true to not remove them. Very counter-intuitive.
• Since 7.7.0 enum values are generated in UPPER_SNAKE_CASE

[jpraet]

Nope, at CBSS we had to rollback to 7.1.0 again because of OpenAPITools/openapi-generator#19188.

[jpraet]

Any other belgif members impacted by OpenAPITools/openapi-generator#19188?

[pvdbosch]

We haven't had any complaints yet, but we're using spring boot more often and we're maintaining variants of the code generation templates (mustache files).