Openapi class

Constructors

Openapi({AdditionalProperties? additionalProperties, bool? overwriteExistingFiles, bool? skipSpecValidation = false, required String inputSpecFile, String? templateDirectory, required Generator generatorName, String? outputDirectory, Map<String, String>? typeMappings, Map<String, String>? importMappings, Map<String, String>? reservedWordsMappings, String? apiPackage, bool? fetchDependencies = true, bool? runSourceGenOnOutput = true, bool? alwaysRun = false})
const

Properties

additionalProperties AdditionalProperties?
Additional properties to pass to the compiler (CSV)
final
alwaysRun bool?
Tells openapi-generator to always run during the build process if set to false (the default), openapi-generator will skip processing if the outputDirectory already exists
final
apiPackage String?
The package of the api. defaults to lib.api
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 setterinherited
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
inputSpecFile String
relative path or url to spec file
final
outputDirectory String?
Where to write the generated files (current dir by default)
final
overwriteExistingFiles bool?
Specifies if the existing files should be overwritten during the generation
final
reservedWordsMappings Map<String, String>?
Add reserver 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 setterinherited
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

Operators

operator ==(Object other) bool
The equality operator.
inherited