openapi_retrofit_generator 2.0.2

openapi_retrofit_generator: ^2.0.2 copied to clipboard

• Packages updated
• Documentation improvements

• Minor documentation fixes

Complete Rework #

Complete rework and refactor of swagger_parser with enhanced architecture, improved code organization, better maintainability and extensibility.

Removed Features #

The following features are no longer available:

• Kotlin Support (language parameter): Multi-language support removed. Package now focuses exclusively on Dart code generation.
• Replacement Rules (replacement_rules parameter): Regex-based name transformation removed in favor of improved automatic naming and conflict resolution. The generator now provides stable, predictable naming with built-in conflict detection and resolution, eliminating the need for user-defined regex transformations. Update your OpenAPI schema with proper component names instead of relying on post-generation transformations.

Simplified Configuration #

The following configuration options have been removed as they are now handled automatically with better defaults:

• use_freezed3: Removed. Freezed 3.x is now the standard version supported.
• use_multipart_file: Removed. File types are now handled automatically: MultipartFile for multipart requests, Uint8List for binary data in regular requests/responses. The dart:io File type is no longer used.
• enums_to_json: Removed. Enum serialization now follows standard serializer patterns automatically.
• enums_parent_prefix: Removed. Enum naming follows standard Dart conventions.
• dart_mappable_convenient_when: Removed. Use Dart 3+ pattern matching instead of legacy when/maybeWhen methods.
• fallback_client renamed to default_client: More intuitive naming for the client handling untagged endpoints.

Changed Defaults #

• use_x_nullable: Changed from false to true (now respects x-nullable extension by default)
• export_file: Changed from true to false

Migration Notes #

• replacement_rules: The improved automatic naming system now handles name normalization and conflict resolution consistently. If you relied on replacement rules, update your OpenAPI schema component names to match your desired output. This ensures stable, predictable code generation.
• language: kotlin: If you need Kotlin generation, consider using a Kotlin-specific OpenAPI generator such as openapi-generator.
• Most other configurations will work without changes

• includeIfNull handling, turned off by default, use include_if_null=true to enable

• Support correct processing of nested allOf classes

• Fix CHANGELOG duplication

• Add complete sealed classes(oneOf/anyOf) support for json_serializeble serializer
  • WARNING: Undiscriminated sealed classes use O(n) try-catch deserialization where n is the number of variants
  • RECOMMENDED: Add discriminator properties to your OpenAPI specification for O(1) performance
  • Add support for sealed classes fallback for failed decoding
• Add complete sealed classes(oneOf/anyOf) support for dart_mappable serializer
  • WARNING: Undiscriminated sealed classes use O(n) try-catch deserialization where n is the number of variants
  • RECOMMENDED: Add discriminator properties to your OpenAPI specification for O(1) performance
  • Add support for sealed classes fallback for failed decoding
• Add dart_mappable_convenient_when option to control union type generation for dart_mappable serializer
  • dart_mappable_convenient_when: true - generates legacy when<T>, maybeWhen<T> methods
  • dart_mappable_convenient_when: false (default) - generates sealed classes for better type safety
• Add @Deprecated() annotation to when<T>, maybeWhen<T> method with dart_mappable. Use dart pattern matching
• Fix creating duplicated unknown property enum with dart_mappable and unknown_enum_value: true
• Fix for handle nullable discriminator unions properly

• Fix resolve inline schemas nested within tagged operations

• Add support for merging all generated code into single output file using the merge_outputs option

Features #

• Add support for non-discriminated unions (oneOf/anyOf without a discriminator)
• Filter out unused schemas when using include_tags or exclude_tags

Fixes #

• Fix the client name for untagged paths to properly fall back to the configured fallback_client instead of client
• Fix the fallback_client configuration to default to fallback instead of default to avoid conflicts with the Dart default keyword in the generated code
• Fix OpenAPI spec parsing to correctly preserve casing for SCREAMING_SNAKE_CASE
• Fix filtering so paths without tags are filtered out when include_tags is specified

• Fix documentation
• Fix ensure consistent file naming for tags with alphanumeric suffixes

• Allow to filter the generation of endpoints in a client by tags
• Allow to define a fallback client for endpoints that do not have a tag - fixes [#271]

• Allow the use of single MultipartFile arguments in multipart requests (requires retrofit_generator 10.0.1 or later)

• Fix for the bug when untagged endpoints and tagged as Client will override each other which results in Client tagged overwritten during file creation

• align default value handling for parameters according to OpenAPi Spec https://swagger.io/docs/specification/v3_0/describing-parameters/#default-parameter-values

• dart_mappable toString override
• dart_mappable toJson return string

• Add support for Freezed fallbackUnion parameter

• Fix broken dart_mappable enum

• Allow using MultipartFile instead of File in multipart requests, to support usage on web.

• proper handling of binary responses aka file downloads, picked up from https://github.com/trevorwang/retrofit.dart/issues/503

• enum toString() override implementation to provide a json value for third party consumers like retrofit

• added generation of getter $valuesDefined to automatically filter out unknown values useful when we would like to list only values that we are aware about

• Fixes allOf case when a mix of ref and properties could unintentionally result in naming overlap now we are deduplicating properties by name

• Fixes typedef transparency which results in import errors when generating json_serializable classes read more details here https://github.com/google/json_serializable.dart/issues/1124

• Remove duplicate parameters in dataclass(#322)

• Fix detection of nullable list with non null items vs nullable list with nullable items(#323)
• Bump Dart SDK to 3.6

• Fixed error with client parameters with $(#262)

• Update dart_mappable template

• Support for allOf composition and xOf (#239)
• Nullable fixes (#251)
• Make list with null in items nullable

• Add supports for freezed 3

• Add supports oneOf polymorphic types with dart_mappable (#290)

• Add x-enumNames(#289)
• Fixed errors with nullable in enums (#216)
• Fixed duplicate class generation when using discriminator (#300)

• Fixed errors with config(#293, #296)

• Add use_x_nullable parameter to config(#295)
• Fixed error with config(#296)

• Fixed config properties inheritance with multi-scheme urls(#293)

• Add support for union types oneOf(#265, #286)
• Fixed config property inheritance

• Fixed errors with config parsing

• Add validation params to generated freezed classes
• Fixed errors with empty schema properties(#280)

• Fix replacement rules for OpenAPI v2(#266)
• Add x-nullable field for null definition in OpenAPI v2(#268)

• Fix generation with anyOf, oneOf and allOf properties(#260)

• Add version getter to root client:

final version = RestClient.version;

• Add dio_options_parameter_by_default

• Remove support of BigInt in Dart for int64 types

• Added support for int64 types

• Fix errors with nullable: false
• Fix same property name conflict(#235)

• Handle empty enum value case (#238)
• Some fixes for the replacement rules
• Support for nullable lists and maps
• Remove config parameter required_by_default, behaviour is now consistent required_by_default: false
• Requires Dart 3.4

• Fixed unnecessary null types with required_by_default: false
• Fixed generation of class parameters that are set directly from the request specification (#224)
• Fixed changing case and applying replacement rules to class names (#223)
• Maps with additionalProperties are now generated correctly (#214)

• Add MappableField to dart_mappable template

• Fixed error with nullable in multipart (#211)

• Add new config parameter extras_parameter_by_default from retrofit 4.1.0 for (#208)
• Fixed errors (#190), (#192) and (#195)

• Fixed errors with required_by_default

• Temporary fix for (#110)
• Ignore parameters start with x- for (#185)
• Fixed parameter type (#186
• Fixed handle $ref (#187) and (#183)

• Add new exceptions to export
• Fixed file name from schemeUrl

• Fix swagger_parser_pages (https://carapacik.github.io/swagger_parser)

• Wrapping collections variable introduced replacing arrayDepth and mapType: this variable presents a list of all collections wrapping a type and will resolve them in order of appearance (#128)
• Fixed error with required_by_default (#168)
• Refactor config and rename parameters:
  • squash_clients to merge_clients
  • enums_prefix to enums_parent_prefix
  • skipp_parameters to skipped_parameters
• Remove config parameter put_in_folder

• Support schema url without extension (#160)

• Fix docs

• Fixed errors with Object body in retrofit client (#110)

• Fixed errors with enum names (#163), (#164)

• Support for generation multipart request with ref (#154)

• Add new config parameter required_by_default
• Added template for E2E tests

• Fixed errors with multipart (#144)

• Removed check that would avoid generating a map when additional properties has a $ref value

• Fixed error with empty content type
• Fixed retrofit template
• Remove special characters from tags
• Add new config parameter skip_parameters
• Extract schemes from url (#150)

• Fixed error with path-level parameters cause crash (#147)
• Fixed dart:io import in template

• Added support for dart_mappable
• Changed freezed schema property to json_serializer, which can be set to freezed, dart_mappable or json_serializable (default).
• Fixed enum generation name that are defined inside an array

• Fixes enum duplicate names (#140)

• Fixed error with ref in a case other than PascalCase (#139)

• Add new config parameter export_file

• Fixed error with annotating client methods with the first specified content type header in OpenAPI V2 schemes if the specified one is not the default.

• Add description of request parameters to the code docs

• Fixed ref component being wrongly labeled as map
• Fixed map components being assigned an import despite not needing one

• Added unknown value to all enums to maintain backwards compatibility when adding new values on the backend
• Add new config parameter unknown_enum_value (dart only) (#106)
• Add new config parameter default_content_type
• Support String values with spaces for enums (#127)

• Fixed map objects parsing as separate entities (#124)

• Fixed error with parsing dictionary objects (#113)

• Fixed error with additionalProperties (#114)

• Add new config parameter original_http_response (dart only) (#115)

• Fix error in body with name in dart template

• Fix error with query parameter named body (#108)

• Support for generating schemes by url (see example)
• Add new config parameter schema_url
• Add new config parameter schema_from_url_to_file
• Add new config parameter prefer_schema_source

• Fix error with required in clients (#101)

• Handling incorrect names for classes, enums and methods.
• Additional name for unnamed models (#98)
• Support for deprecated annotations for methods

• Added display of generation statistics for each scheme and total
• The command to start generation has been changed to dart run swagger_parser
• Fix error with required params in unnamed classes (#98)
• Fix error with missing File import (#101)

• Multiple schemes support (see example)
• Support for specifying nullable types via anyOf
• Edit root client template
• Add new config parameter root_client_name
• Add new config parameter name
• Add new config parameter put_in_folder
• Add new config parameter squash_clients
• Rename root_interface to root_client
• Rename squish_clients to put_clients_in_folder

• Add new config parameter mark_files_as_generated
• Support of default values for ref enum types
• Type support in one-element allOf, anyOf and oneOf

• Fix error with allOf results in the schema with type object (#91)

• Fix grouping words for abbreviations when special characters are present
• Fix replacement type for enum classes
• Takes case in replacement

• Add summary of the methods to the code docs
• Fix indents for multiline code docs
• Add support for root client code docs

• Add new config parameter path_method_name

• Fix error with imports in dto component (#86)

• Fix grouping words for acronyms and abbreviations (#85)

• Fixed method name generation in a language other than English (#83)

• Requires Dart 3.0 or later

• By default value nullable and not required for process default values (#76)
• Add support for common parameters for various paths (#78)

• Fix default enum values in dto (#79)

• Enum prefix only for variable type now

• Fix error with unnamed classes uniques names (#74)

• Fix error with replacement rules in allOf

• Fix error with allOf (#72)

• Add possibility to add enum prefix from parent component (#29). Change enums_prefix to true to enable this option

• Fixed names for negative enum values

• Fixed rename for enums (#69)

• Fixed error with parse nullable item in array (#68)

• Updated retrofit_generator dependency to 7.0.8 and added config option to generate .toJson() methods in enums (retrofit_generator will use .toJson() instead of .name in this case)

• Updated retrofit_generator dependency to 7.0.7 and consequently removed unused .toJson() generated methods in enums

• Add regex replacement for generated class names
• Fixed error with null raw parameter in OpenApi v2 (#63)

• Fixed classes as body parameters (#61)

• Fixed generation default enum values (#58)
• Add new keywords to check the name of variables

• Fixed generation default enum values in client (#56)

• Fixed parsing Body in OpenApi v2 (#53)
• Add multiline comments (#54)
• Fixed items name in enum generation (#55)

• Fixed error with default value in dart json_serializable generation

• Fixed error with application/x-www-form-urlencoded (#45)

• Fixed error with nullable in array (#43)

• Add root_interface option to web interface
• Add topics

• Require Dart >= 2.19
• Add support for description annotation
• Add root_interface option to generate root interface for all Clients
• Refactor code related to nullable

• Now uses ref to identify return type of client method if type also exists

• defaultValue in dart class now generates in constructor
• Fixed error with empty client_postfix

• Fixed error with servers in requests (#32)
• Use operationId for method name(if such a field exists)

• Fixed error with enum values not parsed in object properties
• Use 2xx codes if code 200 not found
• nullable types are now supported

• Use JsonEnum and JsonValue on generated enum

• Single ref sibling elements are now defined as typedefs instead of generating excess classes
• Fixed error with Null type with empty type in schema

• Added DateTime to the format for processing types (#16)

• Support for dio 5
• Downgraded the lower bound of dependencies to support Flutter 3.0
• Complete templates for Kotlin

• Fixed error with import for File type
• Add support for additionalProperties annotations
• Fixed templates
• Fixed error with yaml files

• Update example
• Remove implicit_dynamic field for analyzer

• Fixed error with return type in rest client

• Update docs

• Fixed error with Multipart file type in retrofit
• Update dart api docs
• Update web interface

• Add support for yaml files
• BREAKING: Rename json_path in pubspec.yaml to schema_path

• Fixed problem with default value in freezed template

• Objects are now recognized and are being generated as DTOs
• Fixed some problems with defaultValue
• Fixed some problems with return type
• Fixed some problems with naming parameters whose names are similar to dart keywords

• Fixed a problem with parameters whose names are similar to dart keywords
• Fixed a problem with postfix in file import

• Add support for default annotations
• Add enum support for dart
• Fixed errors with Multipart
• Fixed errors with Kotlin types

• Fixed error with @ in url path
• Fixed the problem with number type to map double
• Fixed the problem with object type to map Dart Object
• Updates the README with instructions and steps to generate the code

• Add support for required annotations
• Fixed error with rest client parameters type in OpenApi v2

• Fixed error with . and , in url path

• Fixed error in MultiPart with single $ref

• Remove swagger_parser section from pubspec.yaml
• Update dependencies in example

• Fixed README
• Fixed workflow files

• Fixed errors with generation of data classes containing allOf
• Fixed errors with templates
• Add web interface for package https://carapacik.github.io/swagger_parser
• Add generator tests

• Initial release