flutter_refit 0.1.0

  • README.md
  • Example
  • Installing
  • Versions
  • new45

flutter_refit

Travis Builds

A library for Dart developers.

Created from templates made available by Stagehand under a BSD-style license.

Usage

A simple usage example:

import 'package:flutter_refit/flutter_refit.dart';

main() {
  var awesome = new Awesome();
}

Features and bugs

Please file feature requests and bugs at the issue tracker.

example/example.dart

library flutter_refit.example;

import 'dart:async';
import 'package:http/http.dart';
import 'package:jaguar_serializer/jaguar_serializer.dart';
import '../lib/flutter_refit.dart';
import 'models/user.dart';

part 'example.api.dart';

/// definition
@RefitHttp(name: "Api")
abstract class ApiDefinition {
  @Get("/users/:id")
  Future<RefitResponse<User>> getUserById(@Param() String id);

  @Post("/users")
  Future<RefitResponse<User>> postUser(@Body() User user);

  @Put("/users/:uid")
  Future<RefitResponse<User>> updateUser(
      @Param("uid") String userId, @Body() User user);

  @Delete("/users/:id")
  Future<RefitResponse> deleteUser(@Param() String id);

  @Get("/users")
  Future<RefitResponse<List<User>>> search(@QueryParam("n") String name, @QueryParam("e") String email);
}

Use this package as a library

1. Depend on it

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


dependencies:
  flutter_refit: "^0.1.0"

2. Install it

You can install packages from the command line:

with pub:


$ pub get

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

3. Import it

Now in your Dart code, you can use:


      import 'package:flutter_refit/flutter_refit.dart';
  
Version Uploaded Documentation Archive
0.1.0 May 27, 2018 Go to the documentation of flutter_refit 0.1.0 Download flutter_refit 0.1.0 archive

Analysis

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

  • Dart: 2.0.0-dev.63.0
  • pana: 0.11.3

Scores

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

Platforms

Detected platforms: other

Primary library: package:flutter_refit/flutter_refit.dart with components: io, isolate, build, mirrors.

Suggestions

  • Maintain CHANGELOG.md.

    Changelog entries help clients to follow the progress in your code.

  • The description is too short.

    Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

  • Package is pre-v1 release.

    While there is nothing inherently wrong with versions of 0.*.*, it usually means that the author is still experimenting with the general direction API.

  • Fix analysis and formatting issues.

    Analysis or formatting checks reported 7 hints.

    Run dartfmt to format lib/build_runner/generator.dart.

    Run dartfmt to format lib/build_runner/utils.dart.

    Similar analysis of the following files failed:

    • lib/flutter_refit.dart (hint)
    • lib/refit/refit.dart (hint)
    • lib/refit/utils.dart (hint)

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.54 <2.0.0
analyzer ^0.31.1 0.31.2-alpha.2 0.32.1
build ^0.12.6 0.12.6
code_builder >2.3.0 <4.0.0 3.1.0
dart_style ^1.0.14 1.1.0
http ^0.11.3 0.11.3+16
jaguar_generator_config ^0.0.1 0.0.1
jaguar_serializer ^1.0.0-dev7 1.0.0-dev9 2.1.5
logging ^0.11.3 0.11.3+1
meta ^1.1.5 1.1.5
source_gen ^0.8.1 0.8.2
Transitive dependencies
args 1.4.3
async 2.0.7
built_collection 3.1.1
built_value 5.5.2
charcode 1.1.1
collection 1.14.10
convert 2.0.1
crypto 2.0.5
csslib 0.14.4
fixnum 0.10.7
front_end 0.1.0-alpha.12 0.1.1
glob 1.1.5
html 0.13.3+1
http_parser 3.1.2
kernel 0.3.0-alpha.12 0.3.1
matcher 0.12.3
package_config 1.0.3
path 1.6.1
plugin 0.2.0+2
quiver 0.29.0+1
source_span 1.4.0
stack_trace 1.9.2
string_scanner 1.0.2
typed_data 1.1.5
utf 0.9.0+4
watcher 0.9.7+8
yaml 2.1.14
Dev dependencies
build_config ^0.2.6
build_runner 0.8.8
jaguar_serializer_cli ^1.0.0-dev8
test ^0.12.38