HTTP client

Http sends outgoing requests to payment gateways, messaging APIs and other services, with Laravel's Http:: API. It uses one pooled dart:io client per application, so connections are reused.

final response = await Http.withToken(apiKey)
    .baseUrl('https://api.example.com')
    .timeout(const Duration(seconds: 10))
    .retry(3, delay: const Duration(milliseconds: 200))
    .acceptJson()
    .post('/v1/charges', json: {'amount': 5000, 'currency': 'idr'});

if (response.successful) {
  final id = response.json('id');        // dot paths: response.json('data.0.id')
}
response.throwIfFailed();                // RequestException on 4xx/5xx

• Requests: get and head (with query:), post, put and patch (with json:, form: or a raw body:), delete.
• Options: baseUrl, withHeaders, withToken, withBasicAuth, withUserAgent, accept / acceptJson, asForm (send json: maps as a form), timeout (30 s by default, as in Laravel).
• retry(times, delay:, when:) tries up to times times when the connection fails or the response is 4xx/5xx, or when when(response, error) says so, and returns the last response. A connection that cannot be made, or a timeout, throws ConnectionException.
• Responses: status, body, json([path, fallback]), jsonMap(), header(name), successful (2xx), ok (200), redirect, clientError, serverError, failed, and throwIfFailed / throwIfClientError / throwIfServerError.

Testing#

Http.fake answers requests without the network and records them:

final http = Http.fake({
  'api.example.com/v1/*': Http.response({'id': 'ch_1'}, 201),
  'hooks.example.com/*': Http.sequence([
    Http.response({'error': 'busy'}, 503),
    Http.response({'ok': true}),
  ]),
  'slow.example.com/*': (ClientRequest request) => Http.response('ok'),
});
Http.preventStrayRequests();   // unstubbed URLs throw instead of answering 200

// ... run the code under test ...

http.assertSent((r) => r.url.host == 'api.example.com' && r.json('amount') == 5000);
http.assertSentCount(1);
http.assertNotSent((r) => r.method == 'DELETE');

Patterns match like Laravel's: * is a wildcard and a missing scheme is allowed, so example.com/* also matches https://shop.example.com/x. Without stubs, every request answers an empty 200.