Openapi class
Constructors
Openapi ({AdditionalProperties ?additionalProperties , bool ?skipSpecValidation = false , required InputSpec inputSpec , String ?templateDirectory , required Generator generatorName , String ?outputDirectory , Map <String String ?typeMappings , Map <String String ?importMappings , Map <String String ?reservedWordsMappings , Map <String String ?inlineSchemaNameMappings , String ?apiPackage , bool ?fetchDependencies = true , bool ?runSourceGenOnOutput = true , String ?cachePath , String ?projectPubspecPath , bool debugLogging = false
const
Properties
additionalProperties → AdditionalProperties ?
Additional properties to pass to the compiler (CSV)
final
apiPackage → String ?
The package of the api. defaults to lib.api
final
cachePath → String ?
The path where to store the cached copy of the specification.
final
debugLogging → bool
Include in depth logging output from run commands.
final
fetchDependencies → bool ?
if set to true, flutter pub get will be run on the outputDirectory after the code has been generated.
Defaults to true for backwards compatibility
final
generatorName → Generator
Generator to use (dart|dart2-api|dart-jaguar|dart-dio)
final
hashCode → int
The hash code for this object.
no setter inherited
importMappings → Map <String String ?
specifies mappings between a given class and the import that should
be used for that class in the format of type=import,type=import. You
can also have multiple occurrences of this option.
final
inlineSchemaNameMappings → Map <String String ?
Inline schemas are created as separate schemas automatically and the
auto-generated schema name may not look good to everyone. One can customize
the name using the title field or the inlineSchemaNameMapping option.
final
inputSpec → InputSpec
Provides the access information to the input spec file.
final
outputDirectory → String ?
Where to write the generated files (current dir by default)
final
projectPubspecPath → String ?
Use a custom pubspec when running the generator.
final
reservedWordsMappings → Map <String String ?
Add reserved words mappings as reservedWord=replacement format.
It is supported by the dart2-api and dart-dio generator.
final
runSourceGenOnOutput → bool ?
if set to true, source gen will be run on the output of openapi-generator
Defaults to true
final
runtimeType → Type
A representation of the runtime type of the object.
no setter inherited
skipSpecValidation → bool ?
Skips the default behavior of validating an input specification.
final
templateDirectory → String ?
folder containing the template files
final
typeMappings → Map <String String ?
sets mappings between OpenAPI spec types and generated code types in
the format of OpenAPIType=generatedType,OpenAPIType=generatedType.
For example: array=List,map=Map,string=String. You can also have
multiple occurrences of this option. To map a specified format, use
type+format, e.g. string+password=EncryptedString will map type: string, format: password to EncryptedString.
final
Methods
noSuchMethod (Invocation invocation → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString ()
→ String
A string representation of this object.
inherited
openapi_generator_annotations 5.0.2 