Skip to content

Latest commit

History

History
59 lines (57 loc) · 7.63 KB

File metadata and controls

59 lines (57 loc) · 7.63 KB

id: generator-opts-client-java title: Config Options for java sidebar_label: java

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.client.model
apiPackagepackage for generated api classesorg.openapitools.client.api
invokerPackageroot package for generated codeorg.openapitools.client
groupIdgroupId in generated pom.xmlorg.openapitools
artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-java-client
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
false
Various third party libraries as needed
false
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 Version
null
useRxJavaWhether to use the RxJava adapter with the retrofit2 library.false
useRxJava2Whether to use the RxJava2 adapter with the retrofit2 library.false
parcelableModelWhether to generate models for Android that implement Parcelable with the okhttp-gson library.false
usePlayWSUse Play! Async HTTP client (Play WS API)false
playVersionVersion of Play! Framework (possible values "play24", "play25" (default), "play26")null
supportJava6Whether to support Java6 with the Jersey1 library.false
useBeanValidationUse BeanValidation API annotationsfalse
performBeanValidationPerform BeanValidationfalse
useGzipFeatureSend gzip-encoded requestsfalse
useRuntimeExceptionUse RuntimeException instead of Exceptionfalse
feignVersionVersion of OpenFeign: '10.x', '9.x' (default)false
useReflectionEqualsHashCodeUse org.apache.commons.lang3.builder for equals and hashCode in the models. WARNING: This will fail under a security manager, unless the appropriate permissions are set up correctly and also there's potential performance impact.false
caseInsensitiveResponseHeadersMake API response's headers case-insensitive. Available on okhttp-gson, jersey2 librariesfalse
librarylibrary template (sub-template) to use
jersey1
HTTP client: Jersey client 1.19.x. JSON processing: Jackson 2.9.x. Enable Java6 support using '-DsupportJava6=true'. Enable gzip request encoding using '-DuseGzipFeature=true'. IMPORTANT NOTE: jersey 1.x is no longer actively maintained so please upgrade to 'jersey2' or other HTTP libaries instead.
jersey2
HTTP client: Jersey client 2.25.1. JSON processing: Jackson 2.9.x
feign
HTTP client: OpenFeign 9.x or 10.x. JSON processing: Jackson 2.9.x. To enable OpenFeign 10.x, set the 'feignVersion' option to '10.x'
okhttp-gson
[DEFAULT] HTTP client: OkHttp 3.x. JSON processing: Gson 2.8.x. Enable Parcelable models on Android using '-DparcelableModel=true'. Enable gzip request encoding using '-DuseGzipFeature=true'.
retrofit
HTTP client: OkHttp 2.x. JSON processing: Gson 2.x (Retrofit 1.9.0). IMPORTANT NOTE: retrofit1.x is no longer actively maintained so please upgrade to 'retrofit2' instead.
retrofit2
HTTP client: OkHttp 3.x. JSON processing: Gson 2.x (Retrofit 2.3.0). Enable the RxJava adapter using '-DuseRxJava[2]=true'. (RxJava 1.x or 2.x)
resttemplate
HTTP client: Spring RestTemplate 4.x. JSON processing: Jackson 2.9.x
webclient
HTTP client: Spring WebClient 5.x. JSON processing: Jackson 2.9.x
resteasy
HTTP client: Resteasy client 3.x. JSON processing: Jackson 2.9.x
vertx
HTTP client: VertX client 3.x. JSON processing: Jackson 2.9.x
google-api-client
HTTP client: Google API client 1.x. JSON processing: Jackson 2.9.x
rest-assured
HTTP client: rest-assured : 4.x. JSON processing: Gson 2.x or Jackson 2.9.x. Only for Java8
native
HTTP client: Java native HttpClient. JSON processing: Jackson 2.9.x. Only for Java11+
okhttp-gson
serializationLibrarySerialization library, default depends from the library
jackson
Use Jackson as serialization library
gson
Use Gson as serialization library
null
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
openapi-generator/docs/generators/java.md at master · dbcfd/openapi-generator · GitHub
Skip to content

Latest commit

History

History
59 lines (57 loc) · 7.63 KB

File metadata and controls

59 lines (57 loc) · 7.63 KB

id: generator-opts-client-java title: Config Options for java sidebar_label: java

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.client.model
apiPackagepackage for generated api classesorg.openapitools.client.api
invokerPackageroot package for generated codeorg.openapitools.client
groupIdgroupId in generated pom.xmlorg.openapitools
artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-java-client
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
false
Various third party libraries as needed
false
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 Version
null
useRxJavaWhether to use the RxJava adapter with the retrofit2 library.false
useRxJava2Whether to use the RxJava2 adapter with the retrofit2 library.false
parcelableModelWhether to generate models for Android that implement Parcelable with the okhttp-gson library.false
usePlayWSUse Play! Async HTTP client (Play WS API)false
playVersionVersion of Play! Framework (possible values "play24", "play25" (default), "play26")null
supportJava6Whether to support Java6 with the Jersey1 library.false
useBeanValidationUse BeanValidation API annotationsfalse
performBeanValidationPerform BeanValidationfalse
useGzipFeatureSend gzip-encoded requestsfalse
useRuntimeExceptionUse RuntimeException instead of Exceptionfalse
feignVersionVersion of OpenFeign: '10.x', '9.x' (default)false
useReflectionEqualsHashCodeUse org.apache.commons.lang3.builder for equals and hashCode in the models. WARNING: This will fail under a security manager, unless the appropriate permissions are set up correctly and also there's potential performance impact.false
caseInsensitiveResponseHeadersMake API response's headers case-insensitive. Available on okhttp-gson, jersey2 librariesfalse
librarylibrary template (sub-template) to use
jersey1
HTTP client: Jersey client 1.19.x. JSON processing: Jackson 2.9.x. Enable Java6 support using '-DsupportJava6=true'. Enable gzip request encoding using '-DuseGzipFeature=true'. IMPORTANT NOTE: jersey 1.x is no longer actively maintained so please upgrade to 'jersey2' or other HTTP libaries instead.
jersey2
HTTP client: Jersey client 2.25.1. JSON processing: Jackson 2.9.x
feign
HTTP client: OpenFeign 9.x or 10.x. JSON processing: Jackson 2.9.x. To enable OpenFeign 10.x, set the 'feignVersion' option to '10.x'
okhttp-gson
[DEFAULT] HTTP client: OkHttp 3.x. JSON processing: Gson 2.8.x. Enable Parcelable models on Android using '-DparcelableModel=true'. Enable gzip request encoding using '-DuseGzipFeature=true'.
retrofit
HTTP client: OkHttp 2.x. JSON processing: Gson 2.x (Retrofit 1.9.0). IMPORTANT NOTE: retrofit1.x is no longer actively maintained so please upgrade to 'retrofit2' instead.
retrofit2
HTTP client: OkHttp 3.x. JSON processing: Gson 2.x (Retrofit 2.3.0). Enable the RxJava adapter using '-DuseRxJava[2]=true'. (RxJava 1.x or 2.x)
resttemplate
HTTP client: Spring RestTemplate 4.x. JSON processing: Jackson 2.9.x
webclient
HTTP client: Spring WebClient 5.x. JSON processing: Jackson 2.9.x
resteasy
HTTP client: Resteasy client 3.x. JSON processing: Jackson 2.9.x
vertx
HTTP client: VertX client 3.x. JSON processing: Jackson 2.9.x
google-api-client
HTTP client: Google API client 1.x. JSON processing: Jackson 2.9.x
rest-assured
HTTP client: rest-assured : 4.x. JSON processing: Gson 2.x or Jackson 2.9.x. Only for Java8
native
HTTP client: Java native HttpClient. JSON processing: Jackson 2.9.x. Only for Java11+
okhttp-gson
serializationLibrarySerialization library, default depends from the library
jackson
Use Jackson as serialization library
gson
Use Gson as serialization library
null
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' openapi-generator/docs/generators/java.md at master · dbcfd/openapi-generator · GitHub
Skip to content

Latest commit

History

History
59 lines (57 loc) · 7.63 KB

File metadata and controls

59 lines (57 loc) · 7.63 KB

id: generator-opts-client-java title: Config Options for java sidebar_label: java

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.client.model
apiPackagepackage for generated api classesorg.openapitools.client.api
invokerPackageroot package for generated codeorg.openapitools.client
groupIdgroupId in generated pom.xmlorg.openapitools
artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-java-client
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
false
Various third party libraries as needed
false
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 Version
null
useRxJavaWhether to use the RxJava adapter with the retrofit2 library.false
useRxJava2Whether to use the RxJava2 adapter with the retrofit2 library.false
parcelableModelWhether to generate models for Android that implement Parcelable with the okhttp-gson library.false
usePlayWSUse Play! Async HTTP client (Play WS API)false
playVersionVersion of Play! Framework (possible values "play24", "play25" (default), "play26")null
supportJava6Whether to support Java6 with the Jersey1 library.false
useBeanValidationUse BeanValidation API annotationsfalse
performBeanValidationPerform BeanValidationfalse
useGzipFeatureSend gzip-encoded requestsfalse
useRuntimeExceptionUse RuntimeException instead of Exceptionfalse
feignVersionVersion of OpenFeign: '10.x', '9.x' (default)false
useReflectionEqualsHashCodeUse org.apache.commons.lang3.builder for equals and hashCode in the models. WARNING: This will fail under a security manager, unless the appropriate permissions are set up correctly and also there's potential performance impact.false
caseInsensitiveResponseHeadersMake API response's headers case-insensitive. Available on okhttp-gson, jersey2 librariesfalse
librarylibrary template (sub-template) to use
jersey1
HTTP client: Jersey client 1.19.x. JSON processing: Jackson 2.9.x. Enable Java6 support using '-DsupportJava6=true'. Enable gzip request encoding using '-DuseGzipFeature=true'. IMPORTANT NOTE: jersey 1.x is no longer actively maintained so please upgrade to 'jersey2' or other HTTP libaries instead.
jersey2
HTTP client: Jersey client 2.25.1. JSON processing: Jackson 2.9.x
feign
HTTP client: OpenFeign 9.x or 10.x. JSON processing: Jackson 2.9.x. To enable OpenFeign 10.x, set the 'feignVersion' option to '10.x'
okhttp-gson
[DEFAULT] HTTP client: OkHttp 3.x. JSON processing: Gson 2.8.x. Enable Parcelable models on Android using '-DparcelableModel=true'. Enable gzip request encoding using '-DuseGzipFeature=true'.
retrofit
HTTP client: OkHttp 2.x. JSON processing: Gson 2.x (Retrofit 1.9.0). IMPORTANT NOTE: retrofit1.x is no longer actively maintained so please upgrade to 'retrofit2' instead.
retrofit2
HTTP client: OkHttp 3.x. JSON processing: Gson 2.x (Retrofit 2.3.0). Enable the RxJava adapter using '-DuseRxJava[2]=true'. (RxJava 1.x or 2.x)
resttemplate
HTTP client: Spring RestTemplate 4.x. JSON processing: Jackson 2.9.x
webclient
HTTP client: Spring WebClient 5.x. JSON processing: Jackson 2.9.x
resteasy
HTTP client: Resteasy client 3.x. JSON processing: Jackson 2.9.x
vertx
HTTP client: VertX client 3.x. JSON processing: Jackson 2.9.x
google-api-client
HTTP client: Google API client 1.x. JSON processing: Jackson 2.9.x
rest-assured
HTTP client: rest-assured : 4.x. JSON processing: Gson 2.x or Jackson 2.9.x. Only for Java8
native
HTTP client: Java native HttpClient. JSON processing: Jackson 2.9.x. Only for Java11+
okhttp-gson
serializationLibrarySerialization library, default depends from the library
jackson
Use Jackson as serialization library
gson
Use Gson as serialization library
null
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' openapi-generator/docs/generators/java.md at master · dbcfd/openapi-generator · GitHub
Skip to content

Latest commit

History

History
59 lines (57 loc) · 7.63 KB

File metadata and controls

59 lines (57 loc) · 7.63 KB

id: generator-opts-client-java title: Config Options for java sidebar_label: java

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.client.model
apiPackagepackage for generated api classesorg.openapitools.client.api
invokerPackageroot package for generated codeorg.openapitools.client
groupIdgroupId in generated pom.xmlorg.openapitools
artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-java-client
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
false
Various third party libraries as needed
false
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 Version
null
useRxJavaWhether to use the RxJava adapter with the retrofit2 library.false
useRxJava2Whether to use the RxJava2 adapter with the retrofit2 library.false
parcelableModelWhether to generate models for Android that implement Parcelable with the okhttp-gson library.false
usePlayWSUse Play! Async HTTP client (Play WS API)false
playVersionVersion of Play! Framework (possible values "play24", "play25" (default), "play26")null
supportJava6Whether to support Java6 with the Jersey1 library.false
useBeanValidationUse BeanValidation API annotationsfalse
performBeanValidationPerform BeanValidationfalse
useGzipFeatureSend gzip-encoded requestsfalse
useRuntimeExceptionUse RuntimeException instead of Exceptionfalse
feignVersionVersion of OpenFeign: '10.x', '9.x' (default)false
useReflectionEqualsHashCodeUse org.apache.commons.lang3.builder for equals and hashCode in the models. WARNING: This will fail under a security manager, unless the appropriate permissions are set up correctly and also there's potential performance impact.false
caseInsensitiveResponseHeadersMake API response's headers case-insensitive. Available on okhttp-gson, jersey2 librariesfalse
librarylibrary template (sub-template) to use
jersey1
HTTP client: Jersey client 1.19.x. JSON processing: Jackson 2.9.x. Enable Java6 support using '-DsupportJava6=true'. Enable gzip request encoding using '-DuseGzipFeature=true'. IMPORTANT NOTE: jersey 1.x is no longer actively maintained so please upgrade to 'jersey2' or other HTTP libaries instead.
jersey2
HTTP client: Jersey client 2.25.1. JSON processing: Jackson 2.9.x
feign
HTTP client: OpenFeign 9.x or 10.x. JSON processing: Jackson 2.9.x. To enable OpenFeign 10.x, set the 'feignVersion' option to '10.x'
okhttp-gson
[DEFAULT] HTTP client: OkHttp 3.x. JSON processing: Gson 2.8.x. Enable Parcelable models on Android using '-DparcelableModel=true'. Enable gzip request encoding using '-DuseGzipFeature=true'.
retrofit
HTTP client: OkHttp 2.x. JSON processing: Gson 2.x (Retrofit 1.9.0). IMPORTANT NOTE: retrofit1.x is no longer actively maintained so please upgrade to 'retrofit2' instead.
retrofit2
HTTP client: OkHttp 3.x. JSON processing: Gson 2.x (Retrofit 2.3.0). Enable the RxJava adapter using '-DuseRxJava[2]=true'. (RxJava 1.x or 2.x)
resttemplate
HTTP client: Spring RestTemplate 4.x. JSON processing: Jackson 2.9.x
webclient
HTTP client: Spring WebClient 5.x. JSON processing: Jackson 2.9.x
resteasy
HTTP client: Resteasy client 3.x. JSON processing: Jackson 2.9.x
vertx
HTTP client: VertX client 3.x. JSON processing: Jackson 2.9.x
google-api-client
HTTP client: Google API client 1.x. JSON processing: Jackson 2.9.x
rest-assured
HTTP client: rest-assured : 4.x. JSON processing: Gson 2.x or Jackson 2.9.x. Only for Java8
native
HTTP client: Java native HttpClient. JSON processing: Jackson 2.9.x. Only for Java11+
okhttp-gson
serializationLibrarySerialization library, default depends from the library
jackson
Use Jackson as serialization library
gson
Use Gson as serialization library
null
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' openapi-generator/docs/generators/java.md at master · dbcfd/openapi-generator · GitHub
Skip to content

Latest commit

History

History
59 lines (57 loc) · 7.63 KB

File metadata and controls

59 lines (57 loc) · 7.63 KB

id: generator-opts-client-java title: Config Options for java sidebar_label: java

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.client.model
apiPackagepackage for generated api classesorg.openapitools.client.api
invokerPackageroot package for generated codeorg.openapitools.client
groupIdgroupId in generated pom.xmlorg.openapitools
artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-java-client
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
false
Various third party libraries as needed
false
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 Version
null
useRxJavaWhether to use the RxJava adapter with the retrofit2 library.false
useRxJava2Whether to use the RxJava2 adapter with the retrofit2 library.false
parcelableModelWhether to generate models for Android that implement Parcelable with the okhttp-gson library.false
usePlayWSUse Play! Async HTTP client (Play WS API)false
playVersionVersion of Play! Framework (possible values "play24", "play25" (default), "play26")null
supportJava6Whether to support Java6 with the Jersey1 library.false
useBeanValidationUse BeanValidation API annotationsfalse
performBeanValidationPerform BeanValidationfalse
useGzipFeatureSend gzip-encoded requestsfalse
useRuntimeExceptionUse RuntimeException instead of Exceptionfalse
feignVersionVersion of OpenFeign: '10.x', '9.x' (default)false
useReflectionEqualsHashCodeUse org.apache.commons.lang3.builder for equals and hashCode in the models. WARNING: This will fail under a security manager, unless the appropriate permissions are set up correctly and also there's potential performance impact.false
caseInsensitiveResponseHeadersMake API response's headers case-insensitive. Available on okhttp-gson, jersey2 librariesfalse
librarylibrary template (sub-template) to use
jersey1
HTTP client: Jersey client 1.19.x. JSON processing: Jackson 2.9.x. Enable Java6 support using '-DsupportJava6=true'. Enable gzip request encoding using '-DuseGzipFeature=true'. IMPORTANT NOTE: jersey 1.x is no longer actively maintained so please upgrade to 'jersey2' or other HTTP libaries instead.
jersey2
HTTP client: Jersey client 2.25.1. JSON processing: Jackson 2.9.x
feign
HTTP client: OpenFeign 9.x or 10.x. JSON processing: Jackson 2.9.x. To enable OpenFeign 10.x, set the 'feignVersion' option to '10.x'
okhttp-gson
[DEFAULT] HTTP client: OkHttp 3.x. JSON processing: Gson 2.8.x. Enable Parcelable models on Android using '-DparcelableModel=true'. Enable gzip request encoding using '-DuseGzipFeature=true'.
retrofit
HTTP client: OkHttp 2.x. JSON processing: Gson 2.x (Retrofit 1.9.0). IMPORTANT NOTE: retrofit1.x is no longer actively maintained so please upgrade to 'retrofit2' instead.
retrofit2
HTTP client: OkHttp 3.x. JSON processing: Gson 2.x (Retrofit 2.3.0). Enable the RxJava adapter using '-DuseRxJava[2]=true'. (RxJava 1.x or 2.x)
resttemplate
HTTP client: Spring RestTemplate 4.x. JSON processing: Jackson 2.9.x
webclient
HTTP client: Spring WebClient 5.x. JSON processing: Jackson 2.9.x
resteasy
HTTP client: Resteasy client 3.x. JSON processing: Jackson 2.9.x
vertx
HTTP client: VertX client 3.x. JSON processing: Jackson 2.9.x
google-api-client
HTTP client: Google API client 1.x. JSON processing: Jackson 2.9.x
rest-assured
HTTP client: rest-assured : 4.x. JSON processing: Gson 2.x or Jackson 2.9.x. Only for Java8
native
HTTP client: Java native HttpClient. JSON processing: Jackson 2.9.x. Only for Java11+
okhttp-gson
serializationLibrarySerialization library, default depends from the library
jackson
Use Jackson as serialization library
gson
Use Gson as serialization library
null
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' openapi-generator/docs/generators/java.md at master · dbcfd/openapi-generator · GitHub
Skip to content

Latest commit

History

History
59 lines (57 loc) · 7.63 KB

File metadata and controls

59 lines (57 loc) · 7.63 KB

id: generator-opts-client-java title: Config Options for java sidebar_label: java

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.client.model
apiPackagepackage for generated api classesorg.openapitools.client.api
invokerPackageroot package for generated codeorg.openapitools.client
groupIdgroupId in generated pom.xmlorg.openapitools
artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-java-client
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
false
Various third party libraries as needed
false
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 Version
null
useRxJavaWhether to use the RxJava adapter with the retrofit2 library.false
useRxJava2Whether to use the RxJava2 adapter with the retrofit2 library.false
parcelableModelWhether to generate models for Android that implement Parcelable with the okhttp-gson library.false
usePlayWSUse Play! Async HTTP client (Play WS API)false
playVersionVersion of Play! Framework (possible values "play24", "play25" (default), "play26")null
supportJava6Whether to support Java6 with the Jersey1 library.false
useBeanValidationUse BeanValidation API annotationsfalse
performBeanValidationPerform BeanValidationfalse
useGzipFeatureSend gzip-encoded requestsfalse
useRuntimeExceptionUse RuntimeException instead of Exceptionfalse
feignVersionVersion of OpenFeign: '10.x', '9.x' (default)false
useReflectionEqualsHashCodeUse org.apache.commons.lang3.builder for equals and hashCode in the models. WARNING: This will fail under a security manager, unless the appropriate permissions are set up correctly and also there's potential performance impact.false
caseInsensitiveResponseHeadersMake API response's headers case-insensitive. Available on okhttp-gson, jersey2 librariesfalse
librarylibrary template (sub-template) to use
jersey1
HTTP client: Jersey client 1.19.x. JSON processing: Jackson 2.9.x. Enable Java6 support using '-DsupportJava6=true'. Enable gzip request encoding using '-DuseGzipFeature=true'. IMPORTANT NOTE: jersey 1.x is no longer actively maintained so please upgrade to 'jersey2' or other HTTP libaries instead.
jersey2
HTTP client: Jersey client 2.25.1. JSON processing: Jackson 2.9.x
feign
HTTP client: OpenFeign 9.x or 10.x. JSON processing: Jackson 2.9.x. To enable OpenFeign 10.x, set the 'feignVersion' option to '10.x'
okhttp-gson
[DEFAULT] HTTP client: OkHttp 3.x. JSON processing: Gson 2.8.x. Enable Parcelable models on Android using '-DparcelableModel=true'. Enable gzip request encoding using '-DuseGzipFeature=true'.
retrofit
HTTP client: OkHttp 2.x. JSON processing: Gson 2.x (Retrofit 1.9.0). IMPORTANT NOTE: retrofit1.x is no longer actively maintained so please upgrade to 'retrofit2' instead.
retrofit2
HTTP client: OkHttp 3.x. JSON processing: Gson 2.x (Retrofit 2.3.0). Enable the RxJava adapter using '-DuseRxJava[2]=true'. (RxJava 1.x or 2.x)
resttemplate
HTTP client: Spring RestTemplate 4.x. JSON processing: Jackson 2.9.x
webclient
HTTP client: Spring WebClient 5.x. JSON processing: Jackson 2.9.x
resteasy
HTTP client: Resteasy client 3.x. JSON processing: Jackson 2.9.x
vertx
HTTP client: VertX client 3.x. JSON processing: Jackson 2.9.x
google-api-client
HTTP client: Google API client 1.x. JSON processing: Jackson 2.9.x
rest-assured
HTTP client: rest-assured : 4.x. JSON processing: Gson 2.x or Jackson 2.9.x. Only for Java8
native
HTTP client: Java native HttpClient. JSON processing: Jackson 2.9.x. Only for Java11+
okhttp-gson
serializationLibrarySerialization library, default depends from the library
jackson
Use Jackson as serialization library
gson
Use Gson as serialization library
null
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' openapi-generator/docs/generators/java.md at master · dbcfd/openapi-generator · GitHub
Skip to content

Latest commit

History

History
59 lines (57 loc) · 7.63 KB

File metadata and controls

59 lines (57 loc) · 7.63 KB

id: generator-opts-client-java title: Config Options for java sidebar_label: java

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.client.model
apiPackagepackage for generated api classesorg.openapitools.client.api
invokerPackageroot package for generated codeorg.openapitools.client
groupIdgroupId in generated pom.xmlorg.openapitools
artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-java-client
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
false
Various third party libraries as needed
false
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 Version
null
useRxJavaWhether to use the RxJava adapter with the retrofit2 library.false
useRxJava2Whether to use the RxJava2 adapter with the retrofit2 library.false
parcelableModelWhether to generate models for Android that implement Parcelable with the okhttp-gson library.false
usePlayWSUse Play! Async HTTP client (Play WS API)false
playVersionVersion of Play! Framework (possible values "play24", "play25" (default), "play26")null
supportJava6Whether to support Java6 with the Jersey1 library.false
useBeanValidationUse BeanValidation API annotationsfalse
performBeanValidationPerform BeanValidationfalse
useGzipFeatureSend gzip-encoded requestsfalse
useRuntimeExceptionUse RuntimeException instead of Exceptionfalse
feignVersionVersion of OpenFeign: '10.x', '9.x' (default)false
useReflectionEqualsHashCodeUse org.apache.commons.lang3.builder for equals and hashCode in the models. WARNING: This will fail under a security manager, unless the appropriate permissions are set up correctly and also there's potential performance impact.false
caseInsensitiveResponseHeadersMake API response's headers case-insensitive. Available on okhttp-gson, jersey2 librariesfalse
librarylibrary template (sub-template) to use
jersey1
HTTP client: Jersey client 1.19.x. JSON processing: Jackson 2.9.x. Enable Java6 support using '-DsupportJava6=true'. Enable gzip request encoding using '-DuseGzipFeature=true'. IMPORTANT NOTE: jersey 1.x is no longer actively maintained so please upgrade to 'jersey2' or other HTTP libaries instead.
jersey2
HTTP client: Jersey client 2.25.1. JSON processing: Jackson 2.9.x
feign
HTTP client: OpenFeign 9.x or 10.x. JSON processing: Jackson 2.9.x. To enable OpenFeign 10.x, set the 'feignVersion' option to '10.x'
okhttp-gson
[DEFAULT] HTTP client: OkHttp 3.x. JSON processing: Gson 2.8.x. Enable Parcelable models on Android using '-DparcelableModel=true'. Enable gzip request encoding using '-DuseGzipFeature=true'.
retrofit
HTTP client: OkHttp 2.x. JSON processing: Gson 2.x (Retrofit 1.9.0). IMPORTANT NOTE: retrofit1.x is no longer actively maintained so please upgrade to 'retrofit2' instead.
retrofit2
HTTP client: OkHttp 3.x. JSON processing: Gson 2.x (Retrofit 2.3.0). Enable the RxJava adapter using '-DuseRxJava[2]=true'. (RxJava 1.x or 2.x)
resttemplate
HTTP client: Spring RestTemplate 4.x. JSON processing: Jackson 2.9.x
webclient
HTTP client: Spring WebClient 5.x. JSON processing: Jackson 2.9.x
resteasy
HTTP client: Resteasy client 3.x. JSON processing: Jackson 2.9.x
vertx
HTTP client: VertX client 3.x. JSON processing: Jackson 2.9.x
google-api-client
HTTP client: Google API client 1.x. JSON processing: Jackson 2.9.x
rest-assured
HTTP client: rest-assured : 4.x. JSON processing: Gson 2.x or Jackson 2.9.x. Only for Java8
native
HTTP client: Java native HttpClient. JSON processing: Jackson 2.9.x. Only for Java11+
okhttp-gson
serializationLibrarySerialization library, default depends from the library
jackson
Use Jackson as serialization library
gson
Use Gson as serialization library
null
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); openapi-generator/docs/generators/java.md at master · dbcfd/openapi-generator · GitHub
Skip to content

Latest commit

History

History
59 lines (57 loc) · 7.63 KB

File metadata and controls

59 lines (57 loc) · 7.63 KB

id: generator-opts-client-java title: Config Options for java sidebar_label: java

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.client.model
apiPackagepackage for generated api classesorg.openapitools.client.api
invokerPackageroot package for generated codeorg.openapitools.client
groupIdgroupId in generated pom.xmlorg.openapitools
artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-java-client
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
false
Various third party libraries as needed
false
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 Version
null
useRxJavaWhether to use the RxJava adapter with the retrofit2 library.false
useRxJava2Whether to use the RxJava2 adapter with the retrofit2 library.false
parcelableModelWhether to generate models for Android that implement Parcelable with the okhttp-gson library.false
usePlayWSUse Play! Async HTTP client (Play WS API)false
playVersionVersion of Play! Framework (possible values "play24", "play25" (default), "play26")null
supportJava6Whether to support Java6 with the Jersey1 library.false
useBeanValidationUse BeanValidation API annotationsfalse
performBeanValidationPerform BeanValidationfalse
useGzipFeatureSend gzip-encoded requestsfalse
useRuntimeExceptionUse RuntimeException instead of Exceptionfalse
feignVersionVersion of OpenFeign: '10.x', '9.x' (default)false
useReflectionEqualsHashCodeUse org.apache.commons.lang3.builder for equals and hashCode in the models. WARNING: This will fail under a security manager, unless the appropriate permissions are set up correctly and also there's potential performance impact.false
caseInsensitiveResponseHeadersMake API response's headers case-insensitive. Available on okhttp-gson, jersey2 librariesfalse
librarylibrary template (sub-template) to use
jersey1
HTTP client: Jersey client 1.19.x. JSON processing: Jackson 2.9.x. Enable Java6 support using '-DsupportJava6=true'. Enable gzip request encoding using '-DuseGzipFeature=true'. IMPORTANT NOTE: jersey 1.x is no longer actively maintained so please upgrade to 'jersey2' or other HTTP libaries instead.
jersey2
HTTP client: Jersey client 2.25.1. JSON processing: Jackson 2.9.x
feign
HTTP client: OpenFeign 9.x or 10.x. JSON processing: Jackson 2.9.x. To enable OpenFeign 10.x, set the 'feignVersion' option to '10.x'
okhttp-gson
[DEFAULT] HTTP client: OkHttp 3.x. JSON processing: Gson 2.8.x. Enable Parcelable models on Android using '-DparcelableModel=true'. Enable gzip request encoding using '-DuseGzipFeature=true'.
retrofit
HTTP client: OkHttp 2.x. JSON processing: Gson 2.x (Retrofit 1.9.0). IMPORTANT NOTE: retrofit1.x is no longer actively maintained so please upgrade to 'retrofit2' instead.
retrofit2
HTTP client: OkHttp 3.x. JSON processing: Gson 2.x (Retrofit 2.3.0). Enable the RxJava adapter using '-DuseRxJava[2]=true'. (RxJava 1.x or 2.x)
resttemplate
HTTP client: Spring RestTemplate 4.x. JSON processing: Jackson 2.9.x
webclient
HTTP client: Spring WebClient 5.x. JSON processing: Jackson 2.9.x
resteasy
HTTP client: Resteasy client 3.x. JSON processing: Jackson 2.9.x
vertx
HTTP client: VertX client 3.x. JSON processing: Jackson 2.9.x
google-api-client
HTTP client: Google API client 1.x. JSON processing: Jackson 2.9.x
rest-assured
HTTP client: rest-assured : 4.x. JSON processing: Gson 2.x or Jackson 2.9.x. Only for Java8
native
HTTP client: Java native HttpClient. JSON processing: Jackson 2.9.x. Only for Java11+
okhttp-gson
serializationLibrarySerialization library, default depends from the library
jackson
Use Jackson as serialization library
gson
Use Gson as serialization library
null