forked from loafle/openapi-generator-original
70108b753e
* [JAVA] fix artifactVersion is not taken from specification when not provided by generator option * update jaxrs-spec samples * update docs generator jaxrs
5.9 KiB
5.9 KiB
id: generator-opts-server-jaxrs-cxf-extended title: Config Options for jaxrs-cxf-extended sidebar_label: jaxrs-cxf-extended
| Option | Description | Values | Default |
|---|---|---|---|
| sortParamsByRequiredFlag | Sort method arguments to place required parameters before optional parameters. | true | |
| ensureUniqueParams | Whether to ensure parameter names are unique in an operation (rename parameters that are not). | true | |
| allowUnicodeIdentifiers | boolean, toggles whether unicode identifiers are allowed in names or not, default is false | false | |
| prependFormOrBodyParameters | Add form or body parameters to the beginning of the parameter list. | false | |
| modelPackage | package for generated models | org.openapitools.model | |
| apiPackage | package for generated api classes | org.openapitools.api | |
| invokerPackage | root package for generated code | org.openapitools.api | |
| groupId | groupId in generated pom.xml | org.openapitools | |
| artifactId | artifactId in generated pom.xml. This also becomes part of the generated library's filename | openapi-cxf-server | |
| artifactVersion | artifact version in generated pom.xml. This also becomes part of the generated library's filename | 1.0.0 | |
| artifactUrl | artifact URL in generated pom.xml | https://github.com/openapitools/openapi-generator | |
| artifactDescription | artifact description in generated pom.xml | OpenAPI Java | |
| scmConnection | SCM connection in generated pom.xml | scm git@github.com:openapitools/openapi-generator.git |
|
| scmDeveloperConnection | SCM developer connection in generated pom.xml | scmgit@github.com:openapitools/openapi-generator.git |
|
| scmUrl | SCM URL in generated pom.xml | https://github.com/openapitools/openapi-generator | |
| developerName | developer name in generated pom.xml | OpenAPI-Generator Contributors | |
| developerEmail | developer email in generated pom.xml | team@openapitools.org | |
| developerOrganization | developer organization in generated pom.xml | OpenAPITools.org | |
| developerOrganizationUrl | developer organization URL in generated pom.xml | http://openapitools.org | |
| licenseName | The name of the license | Unlicense | |
| licenseUrl | The URL of the license | http://unlicense.org | |
| sourceFolder | source folder for generated code | src/main/java | |
| serializableModel | boolean - toggle "implements Serializable" for generated models | false | |
| bigDecimalAsString | Treat BigDecimal values as Strings to avoid precision loss. | false | |
| fullJavaUtil | whether to use fully qualified name for classes under java.util. This option only works for Java API client | false | |
| hideGenerationTimestamp | Hides the generation timestamp when files are generated. | false | |
| withXml | whether 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 | |
| dateLibrary | Option. Date library to use |
|
legacy |
| java8 | Option. Use Java8 classes instead of third party equivalents |
|
false |
| disableHtmlEscaping | Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) | false | |
| booleanGetterPrefix | Set booleanGetterPrefix | get | |
| parentGroupId | parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect | null | |
| parentArtifactId | parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect | null | |
| parentVersion | parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect | null | |
| snapshotVersion | Uses a SNAPSHOT version. |
|
null |
| implFolder | folder for generated implementation code | src/main/java | |
| title | a title describing the application | OpenAPI Server | |
| useBeanValidation | Use BeanValidation API annotations | true | |
| serverPort | The port on which the server should be started | 8080 | |
| generateSpringApplication | Generate Spring application | false | |
| useSpringAnnotationConfig | Use Spring Annotation Config | false | |
| useSwaggerFeature | Use Swagger Feature | false | |
| useSwaggerUI | Use Swagger UI | false | |
| useWadlFeature | Use WADL Feature | false | |
| useMultipartFeature | Use Multipart Feature | false | |
| useGzipFeature | Use Gzip Feature | false | |
| useGzipFeatureForTests | Use Gzip Feature for tests | false | |
| useBeanValidationFeature | Use BeanValidation Feature | false | |
| useLoggingFeature | Use Logging Feature | false | |
| useLoggingFeatureForTests | Use Logging Feature for tests | false | |
| generateSpringBootApplication | Generate Spring Boot application | false | |
| generateJbossDeploymentDescriptor | Generate Jboss Deployment Descriptor | false | |
| addConsumesProducesJson | Add @Consumes/@Produces Json to API interface | false | |
| useAnnotatedBasePath | Use @Path annotations for basePath | false | |
| generateNonSpringApplication | Generate non-Spring application | false | |
| useGenericResponse | Use generic response | false | |
| supportMultipleSpringServices | Support generation of Spring services from multiple specifications | false | |
| generateOperationBody | Generate fully functional operation bodies | false | |
| loadTestDataFromFile | Load test data from a generated JSON file | false | |
| testDataFile | JSON file to contain generated test data | null | |
| testDataControlFile | JSON file to control test data generation | null |