-
-
Notifications
You must be signed in to change notification settings - Fork 6.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[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
- Loading branch information
Showing
280 changed files
with
15,378 additions
and
1,155 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -82,6 +82,7 @@ jobs: | |
- ~/.bundle | ||
- ~/.go_workspace | ||
- ~/.gradle | ||
- ~/.pub-cache | ||
- ~/.cache/bower | ||
- ".git" | ||
- ~/.stack | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
generatorName: dart-dio-next | ||
outputDir: samples/openapi3/client/petstore/dart-dio-next/petstore_client_lib_fake | ||
inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore-with-fake-endpoints-models-for-testing.yaml | ||
templateDir: modules/openapi-generator/src/main/resources/dart/libraries/dio | ||
enablePostProcessFile: "true" | ||
additionalProperties: | ||
hideGenerationTimestamp: "true" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,233 @@ | ||
--- | ||
title: Config Options for dart-dio-next | ||
sidebar_label: dart-dio-next | ||
--- | ||
|
||
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) 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|<dl><dt>**core**</dt><dd>[DEFAULT] Dart core library (DateTime)</dd><dt>**timemachine**</dt><dd>Time Machine is date and time library for Flutter, Web, and Server with support for timezones, calendars, cultures, formatting and parsing.</dd></dl>|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.|<dl><dt>**false**</dt><dd>The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.</dd><dt>**true**</dt><dd>Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.</dd></dl>|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).|<dl><dt>**true**</dt><dd>The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.</dd><dt>**false**</dt><dd>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.</dd></dl>|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|<dl><dt>**built_value**</dt><dd>[DEFAULT] built_value</dd></dl>|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 | ||
|
||
<ul class="column-ul"> | ||
<li>String</li> | ||
<li>bool</li> | ||
<li>double</li> | ||
<li>dynamic</li> | ||
<li>int</li> | ||
<li>num</li> | ||
</ul> | ||
|
||
## RESERVED WORDS | ||
|
||
<ul class="column-ul"> | ||
<li>abstract</li> | ||
<li>as</li> | ||
<li>assert</li> | ||
<li>async</li> | ||
<li>await</li> | ||
<li>break</li> | ||
<li>case</li> | ||
<li>catch</li> | ||
<li>class</li> | ||
<li>const</li> | ||
<li>continue</li> | ||
<li>covariant</li> | ||
<li>default</li> | ||
<li>deferred</li> | ||
<li>do</li> | ||
<li>dynamic</li> | ||
<li>else</li> | ||
<li>enum</li> | ||
<li>export</li> | ||
<li>extends</li> | ||
<li>extension</li> | ||
<li>external</li> | ||
<li>factory</li> | ||
<li>false</li> | ||
<li>final</li> | ||
<li>finally</li> | ||
<li>for</li> | ||
<li>function</li> | ||
<li>get</li> | ||
<li>hide</li> | ||
<li>if</li> | ||
<li>implements</li> | ||
<li>import</li> | ||
<li>in</li> | ||
<li>inout</li> | ||
<li>interface</li> | ||
<li>is</li> | ||
<li>late</li> | ||
<li>library</li> | ||
<li>mixin</li> | ||
<li>native</li> | ||
<li>new</li> | ||
<li>null</li> | ||
<li>of</li> | ||
<li>on</li> | ||
<li>operator</li> | ||
<li>out</li> | ||
<li>part</li> | ||
<li>patch</li> | ||
<li>required</li> | ||
<li>rethrow</li> | ||
<li>return</li> | ||
<li>set</li> | ||
<li>show</li> | ||
<li>source</li> | ||
<li>static</li> | ||
<li>super</li> | ||
<li>switch</li> | ||
<li>sync</li> | ||
<li>this</li> | ||
<li>throw</li> | ||
<li>true</li> | ||
<li>try</li> | ||
<li>typedef</li> | ||
<li>var</li> | ||
<li>void</li> | ||
<li>while</li> | ||
<li>with</li> | ||
<li>yield</li> | ||
</ul> | ||
|
||
## 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.