ChopperClient constructor

ChopperClient({ Uri? baseUrl, Client? client, List<Interceptor> interceptors = const [], Authenticator? authenticator, Converter? converter, ErrorConverter? errorConverter, Iterable<ChopperService>? services, })

Creates and configures a ChopperClient.

The base URL of each request of the registered services can be defined with the baseUrl parameter. E.g., the hostname of your service. If not provided, a empty default Uri will be used.

A custom HTTP client can be passed as the client parameter to be used with the created ChopperClient. If not provided, a default http.Client will be used.

ChopperServices can be added to the client with the services parameter. See the ChopperApi annotation to learn more about creating services.

final chopper = ChopperClient(
  baseUrl: Uri.parse('localhost:8000'),
  services: [
    // Add a generated service
    TodosListService.create()
  ],
);

Interceptors can be added to the client with the interceptors parameter.

See HttpLoggingInterceptor, HeadersInterceptor, CurlInterceptor

final chopper = ChopperClient(
  ...
  interceptors: [
    HttpLoggingInterceptor(),
  ]
);

Converters can be added to the client with the converter parameter. Converters are used to convert the body of requests and responses to and from the HTTP format.

A different converter can be used to handle error responses (when Response.isSuccessful == false)) with tche errorConverter parameter.

See Converter, JsonConverter

final chopper = ChopperClient(
    ...
    converter: JsonConverter(),
    errorConverter: JsonConverter(),
  );

Implementation

ChopperClient({
  Uri? baseUrl,
  http.Client? client,
  this.interceptors = const [],
  this.authenticator,
  this.converter,
  this.errorConverter,
  Iterable<ChopperService>? services,
}) : assert(
       baseUrl == null || !baseUrl.hasQuery,
       'baseUrl should not contain query parameters. '
       'Use a request interceptor to add default query parameters',
     ),
     baseUrl = baseUrl ?? Uri(),
     httpClient = client ?? http.Client(),
     _clientIsInternal = client == null {
  _services = <Type, ChopperService>{
    for (final ChopperService service in services?.toSet() ?? [])
      service.definitionType: service..client = this,
  };
}