retrofit_generator changelog and release notes | pub.dev

NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →

9.3.030 Jun 2025

Added @BodyExtra annotation: Add individual fields to request body without defining complete DTO classes

Added @BodyExtra annotation: Add individual fields to request body without defining complete DTO classes

Support for adding dynamic fields to existing request bodies
expand parameter (default: false) to control object field flattening behavior

Example(Combine fields):

@http.POST('/path/')
Future<String> updateValue(@BodyExtra('id') int id, @BodyExtra('value') String value);

Request body result:

{"id": 123, "value": "some value"}

Example(Combine objects):

// pseudocode
class User {
  int userId;
  String userName;
}

class Settings {
  int a;
  int b;
}

@http.POST('/path/')
Future<String> updateValue(
  @BodyExtra('user', expand: true) User user, 
  @BodyExtra('settings', expand: true) Settings settings,
);

Request body result:

{"userId": 123, "userName": "hhh", "a": 1, "b": 2}

Open source →

9.1.99 Feb 2025

Fixed issue with @Part annotation with toJson() enum values.

Fixed issue with @Part annotation with toJson() enum values.

Example:

import 'package:json_annotation/json_annotation.dart';

@JsonEnum()
enum TestEnumWithToJson { 
  @JsonValue('A')
  A('A'), 
  @JsonValue('B')
  B('B'); 

  const TestEnumWithToJson(this.json);
  
  final String? json;

  String? toJson() => json;
}

@RestApi()
abstract class TestModelList {
  @POST('/')
  Future<void> testEnumWithToJsonType(@Part() TestEnumWithToJson enumValue);
}

Open source →

9.1.89 Feb 2025

Fixed bug of callAdapter using yield/return incorrectly

Fixed bug of callAdapter using yield/return incorrectly

Fixed issue which generated invalid code for the same path parameter appears multiple times.

Example:

@GET('/image/{imageType}/{id}/{id}_XL.png')
Future<HttpResponse<dynamic>> getImage(
  @Path('imageType') ImageType imageType,
  @Path('id') String id,
);

Open source →

9.1.730 Dec 2024

Introduced CallAdapters, This feature allows adaptation of a Call with return type R into the type of T. e.g. Future to Future >

Introduced CallAdapters, This feature allows adaptation of a Call with return type R into the type of T. e.g. Future<User> to Future<Result<User>>

Code Example:

  class MyCallAdapter<T> extends CallAdapter<Future<T>, Future<Either<ApiError, T>>> {
    @override
    Future<Either<ApiError, T>> adapt(Future<T> Function() call) async {
      try {
        final response = await call();
        return Either.right(response);
      }
      catch (e) {
        return Either.left(ApiError(e));
      }
    }
  }

  @RestApi()
  abstract class RestClient {
    factory RestClient(Dio dio, {String? baseUrl}) = _RestClient;

    @UseCallAdapter(MyCallAdapter)
    @GET('/')
    Future<Either<ApiError, User>> getTasks();
  }

Open source →

9.1.514 Nov 2024

Add support for nested object of non-primitive types in TypedExtras.

Add support for nested object of non-primitive types in TypedExtras.

Example :

@RestApi()
abstract class TypedExtrasTest {
  @DummyTypedExtras(
    id: '1234',
    config: Config(
      date: '24-10-2024',
      type: 'analytics',
      shouldReplace: true,
      subConfig: {'date': '24-11-2025'},
    ),
  )
  @GET('path')
  Future<void> list();
}

Open source →

9.1.315 Oct 2024

Add support for multiple TypedExtras.

Add support for multiple TypedExtras.

Example :

@TypedExtrasSubClass(
  id: 'abcd',
  fileType: FileType.json,
  destinations: [Destination.remote]
)
@AnotherTypedExtrasSubClass(
  state: 'Ohio',
  destinations: [Destination.remote]
)
@http.POST('/path/')
Future<String> myMethod();

Open source →

9.1.211 Sept 2024

Support passing Enums into TypedExtras.

Support passing Enums into TypedExtras.

Example :

@TypedExtrasSubClass(
  id: 'abcd',
  fileType: FileType.json,
  destinations: [Destination.remote]
)
@http.POST('/path/')
Future<String> myMethod();

Open source →

9.1.06 Sept 2024

Added @TypedExtras to pass extra options to dio requests using custom annotations.

Added @TypedExtras to pass extra options to dio requests using custom annotations.

Example :

@TypedExtrasSubClass(
  id: 'abcd',
  count: 5,
  shouldProceed: true,
)
@http.POST('/path/')
Future<String> myMethod(@Extras() Map<String, dynamic> extras);

Open source →

8.1.03 Feb 2024

Added @Extras to pass extra options to dio requests, response, transformer and interceptors.

Added @Extras to pass extra options to dio requests, response, transformer and interceptors.

Example :
```
@http.POST('/path/')
Future<String> myMethod(@Extras() Map<String, dynamic> extras);
```

Open source →