title
Documentation for the perl Generator
Property
Value
Notes
generator name
perl
pass this to the generate command after -g
generator stability
STABLE
generator type
CLIENT
generator language
Perl
generator default templating engine
mustache
helpTxt
Generates a Perl client library.
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.
Option
Description
Values
Default
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
moduleName
Perl module name (convention: CamelCase or Long::Module).
OpenAPIClient
moduleVersion
Perl module version.
1.0.0
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
Type/Alias
Instantiated By
ARRAY
DATE
DATE_TIME
HASH
boolean
double
int
object
string
__end__
__file__
__line__
__package__
and
cmp
continue
core
do
else
elsif
eq
exp
for
foreach
ge
gt
if
le
lock
lt
m
ne
no
or
package
q
qq
qr
qw
qx
return
s
sub
tr
unless
until
while
xor
y
Client Modification Feature
Name
Supported
Defined By
BasePath
✓
ToolingExtension
Authorizations
✗
ToolingExtension
UserAgent
✓
ToolingExtension
MockServer
✗
ToolingExtension
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
Uuid
✗
Array
✓
OAS2,OAS3
Null
✗
OAS3
AnyType
✗
OAS2,OAS3
Object
✓
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
Name
Supported
Defined By
Readme
✓
ToolingExtension
Model
✓
ToolingExtension
Api
✓
ToolingExtension
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
Name
Supported
Defined By
Path
✓
OAS2,OAS3
Query
✓
OAS2,OAS3
Header
✓
OAS2,OAS3
Body
✓
OAS2
FormUnencoded
✓
OAS2
FormMultipart
✓
OAS2
Cookie
✓
OAS3
Name
Supported
Defined By
Simple
✓
OAS2,OAS3
Composite
✓
OAS2,OAS3
Polymorphism
✓
OAS2,OAS3
Union
✗
OAS3
allOf
✗
OAS2,OAS3
anyOf
✗
OAS3
oneOf
✗
OAS3
not
✗
OAS3
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
SignatureAuth
✗
OAS3
AWSV4Signature
✗
ToolingExtension
Name
Supported
Defined By
JSON
✓
OAS2,OAS3
XML
✓
OAS2,OAS3
PROTOBUF
✗
ToolingExtension
Custom
✗
OAS2,OAS3