http_middleware_library 0.12.1+hotfix.1

  • Readme
  • Changelog
  • Installing
  • new68

http_middleware #

A middleware library for Dart http library.

Getting Started #

http_middleware is a module that lets you build middleware for Dart's http package.

Installing #

Include this library in your package.

http_middleware: any

Importing #

import 'package:http_middleware/http_middleware.dart';

Using http_middleware #

Create an object of HttpWithMiddleware by using the build factory constructor.

The build constructor takes in a list of middlewares that are built for http_middleware. One very nice middleware you can use is the http_logger package. We will use that here for demonstration.

(You can also build your own middleware for http_middleware. Check out Build your own middleware)
HttpWithMiddleware http = [
    HttpLogger(logLevel: LogLevel.BODY),

That is it! Now go ahead and use this http object as you would normally do.

//Simple POST request
var response = await'',
    body: {"testing", "1234"});

//Simple GET request
var response = await http.get('');

Request Timout

With http_middleware you can also specify the timeout of requests. So if you want a request to be timeout in 30 seconds:

HttpWithMiddleware http =
  requestTimeout: Duration(seconds: 30),
  middlewares: [
    HttpLogger(logLevel: LogLevel.BODY),

You need to catch the exception thrown to know if connection timed out.

try {
  var response = await http.get('');
} catch(e) {
  if (e is TimeoutException) {
    //Timed out

HttpWithMiddleware supports all the functions that http provides.


Using a Client

If you want to use a http.Client in order to keep the connection alive with the server, use HttpClientWithMiddleware.

HttpClientWithMiddleware httpClient = [
    HttpLogger(logLevel: LogLevel.BODY),

var response = await'',
    body: {"testing", "1234"});

var response = await httpClient.get('');

//Don't forget to close the client once done.

Building your own middleware #

Building your own middleware with http_middleware is very easy, whether you want to create a package for http_middleware or you want to build a middleware solely for your own project.

Once you have the necessary imports, all you have to do is extend the MiddlewareContract class which will give you access to 2 functions.

interceptRequest(RequestData) is the method called before any request is made. interceptResponse(ResponseData) is the method called after the response from request is received.

You can then @override all the required functions you need to add middleware to.

Example (A simple logger that logs data in all requests):

class Logger extends MiddlewareContract {
  interceptRequest({RequestData data}) {
    print("Method: ${data.method}");
    print("Url: ${data.url}");
    print("Body: ${data.body}");

  interceptResponse({ResponseData data}) {
    print("Status Code: ${data.statusCode}");
    print("Method: ${data.method}");
    print("Url: ${data.url}");
    print("Body: ${data.body}");
    print("Headers: ${data.headers}");

You can also modify the RequestData before the request is made and every ResponseData after every response is received. For Example, if you want to wrap your data in a particular structure before sending, or you want every request header to have Content-Type set to application/json.

class Logger extends MiddlewareContract {
  interceptRequest({RequestData data}) {
    //Adding content type to every request
    data.headers["Content-Type"] = "application/json";
    data.body = jsonEncode({
      uniqueId: "some unique id",
      data: data.body,

  interceptResponse({ResponseData data}) {
    //Unwrapping response from a structure
    data.body = jsonDecode(data.body)["data"];

Packages built on http_middleware #

If your package uses http_middleware, open an issue and tell me, i will be happy to add it to the list.

[0.12.1] - Update with http last version #

[0.0.1] - TODO: Add release date. #

  • TODO: Describe initial release.

Use this package as a library

1. Depend on it

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

  http_middleware_library: ^0.12.1+hotfix.1

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:http_middleware_library/http_client_with_middleware.dart';
import 'package:http_middleware_library/http_methods.dart';
import 'package:http_middleware_library/http_middleware.dart';
import 'package:http_middleware_library/http_with_middleware.dart';
import 'package:http_middleware_library/middleware_contract.dart';
import 'package:http_middleware_library/models/request_data.dart';
import 'package:http_middleware_library/models/response_data.dart';
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
Learn more about scoring.

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

  • Dart: 2.8.4
  • pana: 0.13.13

Analysis suggestions

Package not compatible with runtime flutter-web on web

Because of the import of dart:io via the import chain package:http_middleware_library/http_client_with_middleware.dartpackage:http/io_client.dartpackage:http/src/io_streamed_response.dartdart:io

Package not compatible with runtime web

Because of the import of dart:io via the import chain package:http_middleware_library/http_client_with_middleware.dartpackage:http/io_client.dartpackage:http/src/io_streamed_response.dartdart:io

Health suggestions

Fix lib/http_client_with_middleware.dart. (-2.48 points)

Analysis of lib/http_client_with_middleware.dart reported 5 hints:

line 98 col 19: Unnecessary new keyword.

line 106 col 44: 'typed' is deprecated and shouldn't be used. Use list.cast

line 108 col 44: 'typed' is deprecated and shouldn't be used. Use map.cast<K, V> instead..

line 110 col 15: Unnecessary new keyword.

line 160 col 11: Unnecessary new keyword.

Fix lib/http_with_middleware.dart. (-1 points)

Analysis of lib/http_with_middleware.dart reported 2 hints:

line 44 col 12: Unnecessary new keyword.

line 127 col 18: Unnecessary new keyword.

Fix lib/middleware_contract.dart. (-0.50 points)

Analysis of lib/middleware_contract.dart reported 1 hint:

line 1 col 8: Unused import: 'dart:typed_data'.

Maintenance suggestions

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and http_middleware_library.dart. Packages with multiple examples should provide example/

For more information see the pub package layout conventions.


Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
collection ^1.14.12 1.14.13
http ^0.12.1 0.12.1
Transitive dependencies
charcode 1.1.3
http_parser 3.1.4
meta 1.1.8
path 1.7.0
pedantic 1.9.0 1.9.1
source_span 1.7.0
string_scanner 1.0.5
term_glyph 1.1.0
typed_data 1.2.0