Changelog #

1.3.1 #

• Add custom options support to each request
• fix #132

1.3.0 #

• Bumped retrofit's SDK requirement to >=2.6.0

1.2.0 #

• Add HttpReponse to handle original response

1.1.0 #

• [BREAKING CHANGE] Add new Part annotation to send multipart/form-data request. Field will not be used in the future, please use Part instead.

1.0.1 #

• Add dio response type support

1.0.0 #

• Support dio 3.0

0.6.3 #

• Added autoCastResponse option to RestApi and all Method annotations (default : true)
• Added auto_cast_response to builder options.

  • Users can specify this in build.yaml as global default

    targets:
      $default:
        sources: ['lib/**']
        builders:
          retrofit_generator|retrofit:
            enabled: true
            options:
              auto_cast_response: true
    
    

0.6.2 #

• fix: fix bad cast exception (#47)
• add CancelToken, SendProgress, and ReceiveProgress (#46)

0.6.0 #

• [BREAKING CHANGE] only works dart 2.2.2 and above
• Added support to multiple clients with different base urls.

0.5.0 #

• Fixed analysis report use retrofit.dart instead of http.dart and dio.dart to import classes

0.4.3 #

• Updated docs and sample code

0.2.3 #

• Added optional parameter fileName in @Field annotation for custom file name

0.2.2 #

• add example

0.2.0 #

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

  Example :

  @http.POST('/path/')
  @dio.Extra({'my_key':'my_value'})
  Future<String>> myMethod();
  

• Fixed general dart style and code conventions

• Automatically null check with ArgumentError.checkNotNull for required parameters

• Now SuperClasses can use forwarding/redirecting constructors instead of static instance() method

  Example :

  @RestApi(baseUrl: "https://httpbin.org/")
  abstract class RestClient {
      /// Forwarding constructor
      factory RestClient([Dio dio]) = _RestClient;
  }
  

0.1.0 #

• fix health issues

0.0.1 #

• init

example/lib/example.dart

import 'dart:convert';

import 'package:json_annotation/json_annotation.dart';
import 'package:retrofit/retrofit.dart';
import 'package:dio/dio.dart' hide Headers;
import 'dart:io';

part 'example.g.dart';

@RestApi(baseUrl: "https://5d42a6e2bc64f90014a56ca0.mockapi.io/api/v1/")
abstract class RestClient {
  factory RestClient(Dio dio, {String baseUrl}) = _RestClient;

  @GET("/tasks")
  Future<List<Task>> getTasks();

  @GET("/tasks/{id}")
  Future<Task> getTask(@Path("id") String id);

  @PATCH("/tasks/{id}")
  Future<Task> updateTaskPart(
      @Path() String id, @Body() Map<String, dynamic> map);

  @PUT("/tasks/{id}")
  Future<Task> updateTask(@Path() String id, @Body() Task task);

  @DELETE("/tasks/{id}")
  Future<void> deleteTask(@Path() String id);

  @POST("/tasks")
  Future<Task> createTask(@Body() Task task);

  @POST("http://httpbin.org/post")
  Future<void> createNewTaskFromFile(@Part() File file);

  @Headers(<String, String>{"accept": "image/jpeg"})
  @GET("http://httpbin.org/image/jpeg")
  @DioResponseType(ResponseType.bytes)
  Future<List<int>> getFile();

  @POST("http://httpbin.org/post")
  @FormUrlEncoded()
  Future<String> postUrlEncodedFormData(@Field() String hello);

  @HEAD('/')
  Future<String> headRequest();

  @GET("/task/group")
  Future<List<TaskGroup>> grouppedTaskByDate();

  @GET("/task")
  Future<HttpResponse<List<Task>>> getTasksWithReponse();

  @DELETE("/tasks/{id}")
  Future<HttpResponse<void>> deleteTaskWithResponse(@Path() String id);

  @POST("https://httpbin.org/post")
  Future<String> postFormData(@Part() Task task, @Part() File file);

  @POST("https://httpbin.org/post")
  Future<String> postFormData2(
      @Part() List<Map<String, dynamic>> task, @Part() File file);

  @POST("https://httpbin.org/post")
  Future<String> postFormData3(
      @Part("customfiles") List<File> files, @Part() File file);

  @POST("https://httpbin.org/post")
  Future<String> postFormData4(@Part() List<Task> tasks, @Part() File file);

  @GET('/demo')
  Future<String> queries(@Queries() Map<String, dynamic> queries);

  @GET("https://httpbin.org/get")
  Future<String> namedExample(@Query("apikey") String apiKey,
      @Query("scope") String scope, @Query("type") String type,
      {@Query("from") int from});

  @POST("/postfile")
  @Headers(<String, dynamic>{
    "Content-Type": "application/octet-stream",
    "Ocp-Apim-Subscription-Key": "abc"
  })
  Future<String> postFile({@Body() File file});

  @GET("")
  Future<String> testCustomOptions(@DioOptions() Options options);
}

@JsonSerializable()
class Task {
  String id;
  String name;
  String avatar;
  String createdAt;

  Task({this.id, this.name, this.avatar, this.createdAt});

  factory Task.fromJson(Map<String, dynamic> json) => _$TaskFromJson(json);
  Map<String, dynamic> toJson() => _$TaskToJson(this);
}

@JsonSerializable()
class TaskGroup {
  DateTime date;
  List<Task> todos;
  List<Task> completed;
  List<Task> inProgress;

  TaskGroup({this.date, this.todos, this.completed, this.inProgress});

  factory TaskGroup.fromJson(Map<String, dynamic> json) =>
      _$TaskGroupFromJson(json);
  Map<String, dynamic> toJson() => _$TaskGroupToJson(this);
}