loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity
openapi-generator/docs/generators/dart-dio-next.md
Peter Leibiger 3d038b74fd
[dart][dart-dio] Next-gen dart-dio generator (#8869) 
* [dart-dio] Remove old Dart 1.x templates

* [dart-dio] Initial version of a next-gen Dart Dio generator

* Fix a couple readme links and examples

* Fix import in testcase

* Add integration tests to master POM

* Run initial dart format and improve some base formatting

* Generate docs

* Use integer matchers in test for content-length

* Separate more built_value specific files

* Fix mustache partial path

* Update pubspec template

* Fix tests after mock lib updates

* Generate with new built_value pre-release

This solves the problem of not being able to serialize null.

* Update built_value dependency

* Regenerate after merge

* Regenerate tests

* Fix missing byte response cast

* Update dio to 4.0.0-prev1

* Run format

* Ignore unused imports in inheritance classes

* Update mock test library

* Update docs

* Make a couple variables final

* Update and freeze dio dependency

* Update generator doc

* Add a new option to post processes all dart output at once

This is much faster than individual files. The committed samples should be formatted since Dart is very opinionated and it makes diffs in PRs much easier to read.
Due to this, we also need to format in CI, otherwise there is a git diff.

* Test some CI stuff
2021-03-20 12:26:56 +08:00

7.1 KiB
Raw Blame History

title sidebar_label
Config Options for dart-dio-next dart-dio-next

These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

Option Description Values Default
allowUnicodeIdentifiers boolean, toggles whether unicode identifiers are allowed in names or not, default is false false
dateLibrary Specify Date library
core
[DEFAULT] Dart core library (DateTime)
timemachine
Time Machine is date and time library for Flutter, Web, and Server with support for timezones, calendars, cultures, formatting and parsing.
 core
disallowAdditionalPropertiesIfNotPresent If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
false
The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
true
Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
 true
ensureUniqueParams Whether to ensure parameter names are unique in an operation (rename parameters that are not). true
legacyDiscriminatorBehavior Set to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C#have this enabled by default).
true
The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
false
The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
 true
prependFormOrBodyParameters Add form or body parameters to the beginning of the parameter list. false
pubAuthor Author name in generated pubspec null
pubAuthorEmail Email address of the author in generated pubspec null
pubDescription Description in generated pubspec null
pubHomepage Homepage in generated pubspec null
pubLibrary Library name in generated code null
pubName Name in generated pubspec null
pubVersion Version in generated pubspec null
serializationLibrary Specify serialization library
built_value
[DEFAULT] built_value
 built_value
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 null
useEnumExtension Allow the 'x-enum-values' extension for enums null

IMPORT MAPPING

Type/Alias Imports

INSTANTIATION TYPES

Type/Alias Instantiated By

LANGUAGE PRIMITIVES

  • String
  • bool
  • double
  • dynamic
  • int
  • num

RESERVED WORDS

  • abstract
  • as
  • assert
  • async
  • await
  • break
  • case
  • catch
  • class
  • const
  • continue
  • covariant
  • default
  • deferred
  • do
  • dynamic
  • else
  • enum
  • export
  • extends
  • extension
  • external
  • factory
  • false
  • final
  • finally
  • for
  • function
  • get
  • hide
  • if
  • implements
  • import
  • in
  • inout
  • interface
  • is
  • late
  • library
  • mixin
  • native
  • new
  • null
  • of
  • on
  • operator
  • out
  • part
  • patch
  • required
  • rethrow
  • return
  • set
  • show
  • source
  • static
  • super
  • switch
  • sync
  • this
  • throw
  • true
  • try
  • typedef
  • var
  • void
  • while
  • with
  • yield

FEATURE SET

Client Modification Feature

Name Supported Defined By
BasePath ✗ ToolingExtension
Authorizations ✗ ToolingExtension
UserAgent ✗ ToolingExtension
MockServer ✗ 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