chopper 3.0.2

  • Readme
  • Changelog
  • Example
  • Installing
  • 94

Chopper #

pub package Build Status codecov Donate

Documentations

Installation #

# pubspec.yaml

dependencies:
  chopper: ^2.0.0

dev_dependencies:
  build_runner: ^1.0.0
  chopper_generator: ^2.0.0

Examples #

Issue Tracker #

Changelog #

3.0.2 #

  • Update analyzer
  • On Response and Request, deprecate replace method, use copyWith instead

3.0.1+1 #

  • Documentations update

3.0.1 #

  • ResponseInterceptor function support typed parameter
  • Fix JsonConverter when converting core types

3.0.0 #

Breaking change New way to handle errors if (response.isSuccessful) { final body = response.body; } else { final error = response.error; }

  • Fix error handling by introducing Response.error getter
  • Remove onError since every response are available via onResponse stream

2.5.0 #

  • Unsuccessful response are not throw anymore, use Response.isSuccessful getter or statusCode instead
  • Support HEAD request

2.4.2 #

  • Fix on JsonConverter If content type header overrided using @Post(headers: {'content-type': '...'}) The converter won't add json header and won't apply json.encode if content type is not JSON

  • add bool override on applyHeader(s) functions, true by default

  • support List<MultipartFile>

2.4.1 #

  • Deprecate @FieldField, use @PartFile instead

2.4.0 #

  • Breaking Change Response.base is now a BaseRequest instead of a Request, which means that you can't do base.body now. Please use Response.bodyBytes or Response.bodyString instead for non streaming case.
  • Now supports streams !
    • You can pass Stream<List<int>> as a body to a request
    • You can also use Stream<List<int>> as the BodyType for the response, in this case the returned response will contain a stream in body.
  • Support passing MutlipartFile (from packages:http) directly to @FileField annotation

2.3.2 #

  • Fix trailing slash when path empty

2.3.1 #

  • Default value for a path is now '' instead of '/'
  • Do not send null value for Multipart request

2.3.0 #

2.2.0 #

  • Fix converter issue on List

    • Breaking Change on Converter.convertResponse<ResultType>(response), it take a new generic type => Converter.convertResponse<ResultType, ItemType>(response)
  • deprecated Chopper.service<Type>(Type), use Chopper.getservice<Type>() instead thanks to @MichaelDark

2.1.0 #

  • fix casting issue

2.0.0 #

  • Fix type safety
  • Fix json converter
  • Handle BuiltList

2.0.0 #

  • Request is now containing baseUrl

  • Can call Request.toHttpRequest() direclty to get the http.BaseRequest will receive

  • If a full url is specified in the path (ex: @Get(path: 'https://...')), it won't be concaten with the baseUrl of the ChopperClient and the ChopperAPI

  • Add CurlInterceptor thanks @edwardaux

  • Add HttpLoggingInterceptor

  • Add FactoryConverter annotation @FactoryConverter(request: convertRequest, response: convertResponse)

  • BreakingChange

    • Method.url renamed to path
    • Converter.encode and Converter.decode removed, implement Converter.convertResponse and Converter.convertRequest` instead
    • ChopperClient.jsonApi deprecated, use a JsonConverter instead
    • ChopperClient.formUrlEncodedApi, use FormUrlEncodedConverter instead
    • remove JsonEncoded annotation, use FactoryConverter instead

1.1.0 #

  • BreakingChange Removed name parameter on ChopperApi New way to instanciate a service

      @ChopperApi()
      abstract class MyService extends ChopperService {
          static MyService create([ChopperClient client]) => _$MyService(client);
      }
    

1.0.0 #

  • Multipart request
  • form url encoded
  • add jsonAPI and formUrlEncodedApi boolean to ChopperClient
  • json and formUrlEncoding are now builtin
  • onError, onResponse, onRequest stream
  • error converter
  • add withClient constructor

0.1.1 #

  • Remove trimSlashes

0.1.0 #

  • update dart sdk

0.0.2 #

  • the generated extension is now *.chopper.dart

  • rename ServiceDefinition to ChopperApi

  • rename ChopperClient.services field to ChopperClient.apis

0.0.1 #

  • Initial version, created by Stagehand

example/main.dart

import 'package:chopper/chopper.dart';
import 'package:chopper/src/interceptor.dart';
import 'definition.dart';

Future<void> main() async {
  final chopper = ChopperClient(
    baseUrl: 'http://localhost:8000',
    services: [
      // the generated service
      MyService.create()
    ],
    converter: JsonConverter(),
  );

  final myService = chopper.getService<MyService>();

  final response = await myService.getMapResource('1');
  print(response.body);

  final list = await myService.getListResources();
  print(list.body);

  chopper.dispose();
}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  chopper: ^3.0.2

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:chopper/chopper.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
95
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
80
Overall:
Weighted score of the above. [more]
94
Learn more about scoring.

We analyzed this package on Jun 5, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.8.2
  • pana: 0.13.8-dev

Maintenance issues and suggestions

Homepage URL doesn't exist. (-20 points)

At the time of the analysis the homepage field https://hadrien-lejard.gitbook.io/chopper was unreachable.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
http >=0.11.0 <1.0.0 0.12.1
logging ^0.11.3 0.11.4
meta ^1.1.2 1.1.8
Transitive dependencies
charcode 1.1.3
collection 1.14.12
path 1.7.0
source_span 1.7.0
string_scanner 1.0.5
term_glyph 1.1.0
typed_data 1.1.6
Dev dependencies
build_runner ^1.0.0
build_test ^0.10.12
chopper_generator
coverage ^0.13.0
http_parser ^3.1.3 3.1.4
pedantic ^1.0.0 1.9.0
test ^1.3.0
test_coverage ^0.4.0