commit	0d2431cfb3e5cf163756d89f5002c3999b3d5dbc	[log] [tgz]
author	nweiz@google.com <nweiz@google.com>	Thu May 01 00:44:53 2014 +0000
committer	nweiz@google.com <nweiz@google.com>	Thu May 01 00:44:53 2014 +0000
tree	af846daf50e5c849e537aa20f05c6eefaca20009
parent	d5144b01b843d82bfeb66371a891a73d8f763b20 [diff]

tree: af846daf50e5c849e537aa20f05c6eefaca20009

README.md

http

A composable, Future-based library for making HTTP requests.

This package contains a set of high-level functions and classes that make it easy to consume HTTP resources.

NOTE: This package currently only works for server-side or command-line Dart applications. In other words, if the app imports dart:io, it can use this package.

Using

The easiest way to use this library is via the top-level functions. They allow you to make individual HTTP requests with minimal hassle:

import 'package:http/http.dart' as http;

var url = "http://example.com/whatsit/create";
http.post(url, body: {"name": "doodle", "color": "blue"})
    .then((response) {
  print("Response status: ${response.statusCode}");
  print("Response body: ${response.body}");
});

http.read("http://example.com/foobar.txt").then(print);

If you‘re making multiple requests to the same server, you can keep open a persistent connection by using a Client rather than making one-off requests. If you do this, make sure to close the client when you’re done:

var client = new http.Client();
client.post(
    "http://example.com/whatsit/create",
    body: {"name": "doodle", "color": "blue"})
  .then((response) => client.get(response.bodyFields['uri']))
  .then((response) => print(response.body))
  .whenComplete(client.close);

You can also exert more fine-grained control over your requests and responses by creating Request or StreamedRequest objects yourself and passing them to Client.send.

This package is designed to be composable. This makes it easy for external libraries to work with one another to add behavior to it. Libraries wishing to add behavior should create a subclass of BaseClient that wraps another Client and adds the desired behavior:

class UserAgentClient extends http.BaseClient {
  final String userAgent;
  final http.Client _inner;

  UserAgentClient(this.userAgent, this._inner);

  Future<StreamedResponse> send(BaseRequest request) {
    request.headers['user-agent'] = userAgent;
    return _inner.send(request);
  }
}

Filing issues

Please file issues for the http package at http://dartbug.com/new.