ShakeHttpClient class

http-package equivalent of ShakeDioInterceptor. Wrap your existing http.Client with ShakeHttpClient(inner) and every request that flows through it is recorded as a NetworkLog.

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

final client = ShakeHttpClient(http.Client());
await client.get(Uri.parse('https://api.example.com/items'));

Headers and bodies are run through RedactionConfig before being stored. Pass a custom redaction to override the singleton policy on LogCapture.instance.redaction.

Constructors

ShakeHttpClient(Client _inner, {bool captureRequestBody = true, bool captureResponseBody = true, bool captureHeaders = true, RedactionConfig? redaction})

Properties

captureHeaders → bool
When false, no headers are captured at all.
final
captureRequestBody → bool
When false, request bodies are omitted from the captured entry.
final
captureResponseBody → bool
When false, response bodies are omitted from the captured entry.
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

close() → void
Closes the client and cleans up any resources associated with it.
delete(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>
Sends an HTTP DELETE request with the given headers to the given URL.
inherited
get(Uri url, {Map<String, String>? headers}) → Future<Response>
Sends an HTTP GET request with the given headers to the given URL.
inherited
Sends an HTTP HEAD request with the given headers to the given URL.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
patch(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>
Sends an HTTP PATCH request with the given headers and body to the given URL.
inherited
post(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>
Sends an HTTP POST request with the given headers and body to the given URL.
inherited
put(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>
Sends an HTTP PUT request with the given headers and body to the given URL.
inherited
read(Uri url, {Map<String, String>? headers}) → Future<String>
Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a String.
inherited
readBytes(Uri url, {Map<String, String>? headers}) → Future<Uint8List>
Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a list of bytes.
inherited
send(BaseRequest request) → Future<StreamedResponse>
Sends an HTTP request and asynchronously returns the response.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited