valitydev/openapi-generator
14
0
Fork 0
mirror of https://github.com/valitydev/openapi-generator.git synced 2024-11-06 10:35:25 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
40cbbbfefd
openapi-generator/docs/generators/java-msf4j.md
Jim Schubert aa7cd4f5af
[docs] Upgrade to Docusaurus 2 (#5271) 
* [docs] Upgrade to Docusaurus 2

Due to formatting issues with Docusaurus 1 and code blocks, and upcoming
4.3 and 5.0 releases, this is an upgrade to have more control over
formatting and other functionality.

This adds behavior to have light/dark themes.

As a consequence of upgrading, columnar format on ul element in
generated generator docs had to be moved to css. This will not impact
users viewing the markdown on GitHub because it didn't display the
column format.

This upgrade should improve syntax highlighting and performance.

* Fix user page layout, choose theme with clear diff colors
2020-02-11 21:22:58 +08:00

9.6 KiB
Raw Blame History

title sidebar_label
Config Options for java-msf4j java-msf4j
Option Description Values Default
additionalModelTypeAnnotations Additional annotations for model type(class level annotations) null
allowUnicodeIdentifiers boolean, toggles whether unicode identifiers are allowed in names or not, default is false false
apiPackage package for generated api classes org.openapitools.api
artifactDescription artifact description in generated pom.xml OpenAPI Java
artifactId artifactId in generated pom.xml. This also becomes part of the generated library's filename openapi-jaxrs-server
artifactUrl artifact URL in generated pom.xml https://github.com/openapitools/openapi-generator
artifactVersion artifact version in generated pom.xml. This also becomes part of the generated library's filename 1.0.0
bigDecimalAsString Treat BigDecimal values as Strings to avoid precision loss. false
booleanGetterPrefix Set booleanGetterPrefix get
dateLibrary Option. 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)
 legacy
developerEmail developer email in generated pom.xml team@openapitools.org
developerName developer name in generated pom.xml OpenAPI-Generator Contributors
developerOrganization developer organization in generated pom.xml OpenAPITools.org
developerOrganizationUrl developer organization URL in generated pom.xml http://openapitools.org
disableHtmlEscaping Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) false
ensureUniqueParams Whether to ensure parameter names are unique in an operation (rename parameters that are not). true
fullJavaUtil whether to use fully qualified name for classes under java.util. This option only works for Java API client false
groupId groupId in generated pom.xml org.openapitools
hideGenerationTimestamp Hides the generation timestamp when files are generated. false
implFolder folder for generated implementation code src/main/java
invokerPackage root package for generated code org.openapitools.api
java8 Option. Use Java8 classes instead of third party equivalents
true
Use Java 8 classes such as Base64
false
Various third party libraries as needed
 false
library library template (sub-template)
jersey1
Jersey core 1.x
jersey2
Jersey core 2.x
 jersey2
licenseName The name of the license Unlicense
licenseUrl The URL of the license http://unlicense.org
modelPackage package for generated models org.openapitools.model
parentArtifactId parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect null
parentGroupId parent groupId 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
prependFormOrBodyParameters Add form or body parameters to the beginning of the parameter list. false
scmConnection SCM connection in generated pom.xml scm:git:git@github.com:openapitools/openapi-generator.git
scmDeveloperConnection SCM developer connection in generated pom.xml scm:git:git@github.com:openapitools/openapi-generator.git
scmUrl SCM URL in generated pom.xml https://github.com/openapitools/openapi-generator
serializableModel boolean - toggle "implements Serializable" for generated models false
serverPort The port on which the server should be started 8080
snapshotVersion Uses a SNAPSHOT version.
true
Use a SnapShot Version
false
Use a Release Version
 null
sortModelPropertiesByRequiredFlag Sort model properties to place required parameters before optional parameters. true
sortParamsByRequiredFlag Sort method arguments to place required parameters before optional parameters. true
sourceFolder source folder for generated code src/main/java
title a title describing the application OpenAPI Server
useBeanValidation Use BeanValidation API annotations true
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

IMPORT MAPPING

Type/Alias Imports
Array java.util.List
ArrayList java.util.ArrayList
BigDecimal java.math.BigDecimal
Date java.util.Date
DateTime org.joda.time.*
File java.io.File
HashMap java.util.HashMap
List java.util.*
LocalDate org.joda.time.*
LocalDateTime org.joda.time.*
LocalTime org.joda.time.*
Map java.util.Map
Set java.util.*
Timestamp java.sql.Timestamp
URI java.net.URI
UUID java.util.UUID

INSTANTIATION TYPES

Type/Alias Instantiated By
array ArrayList
map HashMap

LANGUAGE PRIMITIVES

  • Boolean
  • Double
  • Float
  • Integer
  • Long
  • Object
  • String
  • boolean
  • byte[]

RESERVED WORDS

  • abstract
  • apiclient
  • apiexception
  • apiresponse
  • assert
  • boolean
  • break
  • byte
  • case
  • catch
  • char
  • class
  • configuration
  • const
  • continue
  • default
  • do
  • double
  • else
  • enum
  • extends
  • final
  • finally
  • float
  • for
  • goto
  • if
  • implements
  • import
  • instanceof
  • int
  • interface
  • localreturntype
  • localvaraccept
  • localvaraccepts
  • localvarauthnames
  • localvarcollectionqueryparams
  • localvarcontenttype
  • localvarcontenttypes
  • localvarcookieparams
  • localvarformparams
  • localvarheaderparams
  • localvarpath
  • localvarpostbody
  • localvarqueryparams
  • long
  • native
  • new
  • null
  • object
  • package
  • private
  • protected
  • public
  • return
  • short
  • static
  • strictfp
  • stringutil
  • super
  • switch
  • synchronized
  • this
  • throw
  • throws
  • transient
  • try
  • void
  • volatile
  • while

FEATURE SET

Client Modification Feature

Name Supported Defined By
BasePath ✓ ToolingExtension
Authorizations ✗ ToolingExtension
UserAgent ✗ ToolingExtension

Data Type Feature

Name Supported Defined By
Custom ✗ OAS2,OAS3
Int32 ✓ OAS2,OAS3
Int64 ✓ OAS2,OAS3
Float ✓ OAS2,OAS3
Double ✓ OAS2,OAS3
Decimal ✓ ToolingExtension
String ✓ OAS2,OAS3
Byte ✓ OAS2,OAS3
Binary ✓ OAS2,OAS3
Boolean ✓ OAS2,OAS3
Date ✓ OAS2,OAS3
DateTime ✓ OAS2,OAS3
Password ✓ OAS2,OAS3
File ✓ OAS2
Array ✓ OAS2,OAS3
Maps ✓ ToolingExtension
CollectionFormat ✓ OAS2
CollectionFormatMulti ✓ OAS2
Enum ✓ OAS2,OAS3
ArrayOfEnum ✓ ToolingExtension
ArrayOfModel ✓ ToolingExtension
ArrayOfCollectionOfPrimitives ✓ ToolingExtension
ArrayOfCollectionOfModel ✓ ToolingExtension
ArrayOfCollectionOfEnum ✓ ToolingExtension
MapOfEnum ✓ ToolingExtension
MapOfModel ✓ ToolingExtension
MapOfCollectionOfPrimitives ✓ ToolingExtension
MapOfCollectionOfModel ✓ ToolingExtension
MapOfCollectionOfEnum ✓ ToolingExtension

Documentation Feature

Name Supported Defined By
Readme ✓ ToolingExtension
Model ✓ ToolingExtension
Api ✓ ToolingExtension

Global Feature

Name Supported Defined By
Host ✓ OAS2,OAS3
BasePath ✓ OAS2,OAS3
Info ✓ OAS2,OAS3
Schemes ✗ OAS2,OAS3
PartialSchemes ✓ OAS2,OAS3
Consumes ✓ OAS2
Produces ✓ OAS2
ExternalDocumentation ✓ OAS2,OAS3
Examples ✓ OAS2,OAS3
XMLStructureDefinitions ✗ OAS2,OAS3
MultiServer ✗ OAS3
ParameterizedServer ✗ OAS3
ParameterStyling ✗ OAS3
Callbacks ✗ OAS3
LinkObjects ✗ OAS3

Parameter Feature

Name Supported Defined By
Path ✓ OAS2,OAS3
Query ✓ OAS2,OAS3
Header ✓ OAS2,OAS3
Body ✓ OAS2
FormUnencoded ✓ OAS2
FormMultipart ✓ OAS2
Cookie ✓ OAS3

Schema Support Feature

Name Supported Defined By
Simple ✓ OAS2,OAS3
Composite ✓ OAS2,OAS3
Polymorphism ✗ OAS2,OAS3
Union ✗ OAS3

Security Feature

Name Supported Defined By
BasicAuth ✗ OAS2,OAS3
ApiKey ✗ OAS2,OAS3
OpenIDConnect ✗ OAS3
BearerToken ✗ OAS3
OAuth2_Implicit ✗ OAS2,OAS3
OAuth2_Password ✗ OAS2,OAS3
OAuth2_ClientCredentials ✗ OAS2,OAS3
OAuth2_AuthorizationCode ✗ OAS2,OAS3

Wire Format Feature

Name Supported Defined By
JSON ✓ OAS2,OAS3
XML ✓ OAS2,OAS3
PROTOBUF ✗ ToolingExtension
Custom ✗ OAS2,OAS3