generators/spring

id: generator-opts-server-spring title: Config Options for springsidebar_label: spring

OptionDescriptionValuesDefault
sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
modelPackagepackage for generated modelsorg.openapitools.model
apiPackagepackage for generated api classesorg.openapitools.api
invokerPackageroot package for generated codeorg.openapitools.api
groupIdgroupId in generated pom.xmlorg.openapitools
artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-spring
artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
licenseNameThe name of the licenseUnlicense
licenseUrlThe URL of the licensehttp://unlicense.org
sourceFoldersource folder for generated codesrc/main/java
serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
hideGenerationTimestampHides the generation timestamp when files are generated.false
withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false
dateLibraryOption. Date library to use- joda- Joda (for legacy app only)- legacy- Legacy java.util.Date (if you really have a good reason not to use threetenbp- java8-localdatetime- Java 8 using LocalDateTime (for legacy app only)- java8- Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true- threetenbp- Backport of JSR310 (preferred for jdk < 1.8)threetenbp
java8Option. Use Java8 classes instead of third party equivalents- true- Use Java 8 classes such as Base64. Use java8 default interface when a responseWrapper is used- false- Various third party libraries as neededfalse
disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
booleanGetterPrefixSet booleanGetterPrefixget
parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
snapshotVersionUses a SNAPSHOT version.- true- Use a SnapShot Version- false- Use a Release Versionnull
titleserver title name or client service nameOpenAPI Spring
configPackageconfiguration package for generated codeorg.openapitools.configuration
basePackagebase package (invokerPackage) for generated codeorg.openapitools
interfaceOnlyWhether to generate only API interface stubs without the server files.false
delegatePatternWhether to generate the server files using the delegate patternfalse
singleContentTypesWhether to select only one produces/consumes content-type by operation.false
skipDefaultInterfaceWhether to generate default implementations for java8 interfacesfalse
asyncuse async Callable controllersfalse
reactivewrap responses in Mono/Flux Reactor types (spring-boot only)false
responseWrapperwrap the responses in given type (Future,Callable,CompletableFuture,ListenableFuture,DeferredResult,HystrixCommand,RxObservable,RxSingle or fully qualified type)null
virtualServiceGenerates the virtual service. For more details refer - https://github.com/elan-venture/virtualan/wikifalse
useTagsuse tags for creating interface and controller classnamesfalse
useBeanValidationUse BeanValidation API annotationstrue
performBeanValidationUse Bean Validation Impl. to perform BeanValidationfalse
implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
swaggerDocketConfigGenerate Spring OpenAPI Docket configuration class.false
apiFirstGenerate the API from the OAI spec at server compile time (API first approach)false
useOptionalUse Optional container for optional parametersfalse
hateoasUse Spring HATEOAS library to allow adding HATEOAS linksfalse
returnSuccessCodeGenerated server returns 2xx codefalse
unhandledExceptionDeclare operation methods to throw a generic exception and allow unhandled exceptions (useful for Spring @ControllerAdvice directives).false
librarylibrary template (sub-template)- spring-boot- Spring-boot Server application using the SpringFox integration.- spring-mvc- Spring-MVC Server application using the SpringFox integration.- spring-cloud- Spring-Cloud-Feign client with Spring-Boot auto-configured settings.spring-boot