Package io.quarkiverse.openapi.generator.deployment.wrapper

Class OpenApiClientGeneratorWrapper

java.lang.Object

io.quarkiverse.openapi.generator.deployment.wrapper.OpenApiClientGeneratorWrapper

Direct Known Subclasses:

OpenApiClassicClientGeneratorWrapper, OpenApiReactiveClientGeneratorWrapper

public abstract class OpenApiClientGeneratorWrapper
extends Object

Wrapper for the OpenAPIGen tool. This is the same as calling the Maven plugin or the CLI. We are wrapping into a class to generate code that meet our requirements.

See Also:

• OpenAPI Generator Client for Java

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_SECURITY_SCHEME	Security scheme for which to apply security constraints even if the OpenAPI definition has no security definition
static final String	SUPPORTS_ADDITIONAL_PROPERTIES_AS_ATTRIBUTE
static final String	VERBOSE

Method Summary

Modifier and Type	Method	Description
List<File>	generate(String basePackage)	Main entrypoint, or where to generate the files based on the given base package.
static String	transformToSafeConfigKey(String input)
OpenApiClientGeneratorWrapper	withAdditionalApiTypeAnnotationsConfig(String additionalApiTypeAnnotations)	Sets the global 'additionalApiTypeAnnotations' setting.
OpenApiClientGeneratorWrapper	withAdditionalEnumTypeUnexpectedMemberConfig(Boolean additionalEnumTypeUnexpectedMember)
OpenApiClientGeneratorWrapper	withAdditionalEnumTypeUnexpectedMemberNameConfig(String additionalEnumTypeUnexpectedMemberName)
OpenApiClientGeneratorWrapper	withAdditionalEnumTypeUnexpectedMemberStringValueConfig(String additionalEnumTypeUnexpectedMemberStringValue)
OpenApiClientGeneratorWrapper	withAdditionalModelTypeAnnotationsConfig(String additionalModelTypeAnnotations)	Sets the global 'additionalModelTypeAnnotations' setting.
void	withAdditionalPropertiesAsAttribute(Boolean enable)
OpenApiClientGeneratorWrapper	withAdditionalRequestArgs(String additionalRequestArgs)
OpenApiClientGeneratorWrapper	withApiNameSuffix(String apiNameSuffix)
OpenApiClientGeneratorWrapper	withCircuitBreakerConfig(Map<String,List<String>> config)	Adds the circuit breaker configuration to the generator.
OpenApiClientGeneratorWrapper	withClassesCodeGenConfig(Map<String,Object> config)
void	withConfigKey(String config)
OpenApiClientGeneratorWrapper	withEnabledSecurityGeneration(Boolean enableSecurityGeneration)
OpenApiClientGeneratorWrapper	withEqualsHashcode(Boolean equalsHashcode)
OpenApiClientGeneratorWrapper	withGenerateApis(Boolean config)
OpenApiClientGeneratorWrapper	withGenerateModels(Boolean config)
OpenApiClientGeneratorWrapper	withGeneratePartFilenameConfig(Boolean generatePartFilename)
OpenApiClientGeneratorWrapper	withImportMappings(Map<String,String> typeMappings)
OpenApiClientGeneratorWrapper	withModelNamePrefix(String modelNamePrefix)
OpenApiClientGeneratorWrapper	withModelNameSuffix(String modelNameSuffix)
OpenApiClientGeneratorWrapper	withMutiny(Boolean config)
OpenApiClientGeneratorWrapper	withMutinyReturnResponse(Boolean config)
OpenApiClientGeneratorWrapper	withMutinyReturnTypes(Map<String,String> returnTypeMappings)
OpenApiClientGeneratorWrapper	withOpenApiNormalizer(Map<String,String> openApiNormalizer)
OpenApiClientGeneratorWrapper	withPartFilenameValueConfig(String partFilenameValue)
OpenApiClientGeneratorWrapper	withRemoveOperationIdPrefix(Boolean removeOperationIdPrefix)
OpenApiClientGeneratorWrapper	withRemoveOperationIdPrefixCount(Integer removeOperationIdPrefixCount)
OpenApiClientGeneratorWrapper	withRemoveOperationIdPrefixDelimiter(String removeOperationIdPrefixDelimiter)
OpenApiClientGeneratorWrapper	withReturnResponse(Boolean returnResponse)
OpenApiClientGeneratorWrapper	withSchemaMappings(Map<String,String> typeMappings)
OpenApiClientGeneratorWrapper	withSerialiableModel(Boolean serialiableModel)
OpenApiClientGeneratorWrapper	withSkipFormModelConfig(String skipFormModel)	Sets the global 'skipFormModel' setting.
void	withTemplateDir(Path templateDir)
OpenApiClientGeneratorWrapper	withTypeMappings(Map<String,String> typeMappings)
OpenApiClientGeneratorWrapper	withUseBeanValidation(Boolean config)
OpenApiClientGeneratorWrapper	withUseFieldNameInPartFilenameConfig(Boolean useFieldNameInPartFilename)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

VERBOSE

public static final String VERBOSE

See Also:

• Constant Field Values

DEFAULT_SECURITY_SCHEME

public static final String DEFAULT_SECURITY_SCHEME

Security scheme for which to apply security constraints even if the OpenAPI definition has no security definition

See Also:

• Constant Field Values

SUPPORTS_ADDITIONAL_PROPERTIES_AS_ATTRIBUTE

public static final String SUPPORTS_ADDITIONAL_PROPERTIES_AS_ATTRIBUTE

See Also:

• Constant Field Values

Method Details

withCircuitBreakerConfig

public OpenApiClientGeneratorWrapper withCircuitBreakerConfig(Map<String,List<String>> config)

Adds the circuit breaker configuration to the generator.

Parameters:

config - a map of class names and their methods that should be configured with circuit breaker

Returns:

this wrapper

withClassesCodeGenConfig

public OpenApiClientGeneratorWrapper withClassesCodeGenConfig(Map<String,Object> config)

withMutiny

public OpenApiClientGeneratorWrapper withMutiny(Boolean config)

withMutinyReturnResponse

public OpenApiClientGeneratorWrapper withMutinyReturnResponse(Boolean config)

withMutinyReturnTypes

public OpenApiClientGeneratorWrapper withMutinyReturnTypes(Map<String,String> returnTypeMappings)

withSkipFormModelConfig

public OpenApiClientGeneratorWrapper withSkipFormModelConfig(String skipFormModel)

Sets the global 'skipFormModel' setting. If not set this setting will default to true.

Parameters:

skipFormModel - whether to skip the generation of models for form parameters

Returns:

this wrapper

withTypeMappings

public OpenApiClientGeneratorWrapper withTypeMappings(Map<String,String> typeMappings)

withReturnResponse

public OpenApiClientGeneratorWrapper withReturnResponse(Boolean returnResponse)

withEnabledSecurityGeneration

public OpenApiClientGeneratorWrapper withEnabledSecurityGeneration(Boolean enableSecurityGeneration)

withImportMappings

public OpenApiClientGeneratorWrapper withImportMappings(Map<String,String> typeMappings)

withSchemaMappings

public OpenApiClientGeneratorWrapper withSchemaMappings(Map<String,String> typeMappings)

withOpenApiNormalizer

public OpenApiClientGeneratorWrapper withOpenApiNormalizer(Map<String,String> openApiNormalizer)

withSerialiableModel

public OpenApiClientGeneratorWrapper withSerialiableModel(Boolean serialiableModel)

withEqualsHashcode

public OpenApiClientGeneratorWrapper withEqualsHashcode(Boolean equalsHashcode)

withAdditionalModelTypeAnnotationsConfig

public OpenApiClientGeneratorWrapper withAdditionalModelTypeAnnotationsConfig(String additionalModelTypeAnnotations)

Sets the global 'additionalModelTypeAnnotations' setting. If not set this setting will default to empty.

Parameters:

additionalModelTypeAnnotations - the list of extra additional annotations to be included in a model

Returns:

this wrapper

withAdditionalEnumTypeUnexpectedMemberConfig

public OpenApiClientGeneratorWrapper withAdditionalEnumTypeUnexpectedMemberConfig(Boolean additionalEnumTypeUnexpectedMember)

withAdditionalEnumTypeUnexpectedMemberNameConfig

public OpenApiClientGeneratorWrapper withAdditionalEnumTypeUnexpectedMemberNameConfig(String additionalEnumTypeUnexpectedMemberName)

withAdditionalEnumTypeUnexpectedMemberStringValueConfig

public OpenApiClientGeneratorWrapper withAdditionalEnumTypeUnexpectedMemberStringValueConfig(String additionalEnumTypeUnexpectedMemberStringValue)

withAdditionalApiTypeAnnotationsConfig

public OpenApiClientGeneratorWrapper withAdditionalApiTypeAnnotationsConfig(String additionalApiTypeAnnotations)

Sets the global 'additionalApiTypeAnnotations' setting. If not set this setting will default to empty.

Parameters:

additionalApiTypeAnnotations - the list of extra additional annotations to be included in an api

Returns:

this wrapper

withAdditionalRequestArgs

public OpenApiClientGeneratorWrapper withAdditionalRequestArgs(String additionalRequestArgs)

withTemplateDir

public void withTemplateDir(Path templateDir)

withGeneratePartFilenameConfig

public OpenApiClientGeneratorWrapper withGeneratePartFilenameConfig(Boolean generatePartFilename)

withPartFilenameValueConfig

public OpenApiClientGeneratorWrapper withPartFilenameValueConfig(String partFilenameValue)

withUseFieldNameInPartFilenameConfig

public OpenApiClientGeneratorWrapper withUseFieldNameInPartFilenameConfig(Boolean useFieldNameInPartFilename)

withUseBeanValidation

public OpenApiClientGeneratorWrapper withUseBeanValidation(Boolean config)

withGenerateApis

public OpenApiClientGeneratorWrapper withGenerateApis(Boolean config)

withGenerateModels

public OpenApiClientGeneratorWrapper withGenerateModels(Boolean config)

withApiNameSuffix

public OpenApiClientGeneratorWrapper withApiNameSuffix(String apiNameSuffix)

withModelNameSuffix

public OpenApiClientGeneratorWrapper withModelNameSuffix(String modelNameSuffix)

withRemoveOperationIdPrefix

public OpenApiClientGeneratorWrapper withRemoveOperationIdPrefix(Boolean removeOperationIdPrefix)

withRemoveOperationIdPrefixDelimiter

public OpenApiClientGeneratorWrapper withRemoveOperationIdPrefixDelimiter(String removeOperationIdPrefixDelimiter)

withRemoveOperationIdPrefixCount

public OpenApiClientGeneratorWrapper withRemoveOperationIdPrefixCount(Integer removeOperationIdPrefixCount)

withModelNamePrefix

public OpenApiClientGeneratorWrapper withModelNamePrefix(String modelNamePrefix)

generate

public List<File> generate(String basePackage)

Main entrypoint, or where to generate the files based on the given base package.

Parameters:

basePackage - Java package name, e.g. org.acme

Returns:

a list of generated files

withConfigKey

public void withConfigKey(String config)

withAdditionalPropertiesAsAttribute

public void withAdditionalPropertiesAsAttribute(Boolean enable)

transformToSafeConfigKey

public static String transformToSafeConfigKey(String input)