a dart library to make HTTP requests (inspired by python requests module). It comes with JSON support and a lightweight implementation to store cookies like a browser.
Server side cookies (via response header SET-COOKIE
) are stored using the assistance of quiver.cache
. Stored cookies will be send seamlessly on the next http requests you make to the same domain (simple implementation, similar to a web browser).
Add this to your package's pubspec.yaml file:
dependencies:
requests: ^4.8.0-alpha.0
Start by importing the library
import 'package:requests/requests.dart';
Let's make a simple HTTP request
var r = await Requests.get('https://google.com');
r.raiseForStatus();
String body = r.content();
Response
objectjust like in python's request module, the Response
object has this functionality
r.throwForStatus()
- will throw an exception if the response statusCode
is not a great success.r.raiseForStatus()
- same as throwForStatus
r.statusCode
- the response status coder.url
- the url in the request r.headers
- the response headers r.success
- a boolean. true
indicates that the request was a great success r.hasError
- a boolean. true
indicates that the request was not a great success r.bytes()
- return the body in the response as a list of bytes r.content()
- return the body in the response as a stringr.json()
- recodes the body in the response and returns the result (dynamic type)json
- a dynamic
object that will be json encoded and then be set as the request's bodybody
- a raw string to be used as the request's bodybodyEncoding
- default RequestBodyEncoding.FormURLEncoded
. will set the content-type
headerheaders
- Map<String, String>
of custom client headers to add in the requesttimeoutSeconds
- default 10
seconds. after that period of time without server response an exception is thrownpersistCookies
- default true
. if should respect server's command to persist cookieverify
- default true
. if the SSL verification enabledwithCredentials
- default false
. for dart web to handle cookies, authorization headers, or TLS client certificatesNote: Only one optional argument can be used in a single request
body
orjson
.clearStoredCookies(url)
- clears the stored cookies for the url.setStoredCookies(url, CookieJar)
- set the stored cookies for the url.getStoredCookies(url)
- returns a CookieJar of the stored cookies for the url.addCookie(url, name, value)
- add a Cookie to the CookieJar associated to the urlHTTP post, body encoded as application/x-www-form-urlencoded, parse response as json
var r = await Requests.post(
'https://reqres.in/api/users',
body: {
'userId': 10,
'id': 91,
'title': 'aut amet sed',
},
bodyEncoding: RequestBodyEncoding.FormURLEncoded);
r.raiseForStatus();
dynamic json = r.json();
print(json!['id']);
HTTP delete
var r = await Requests.delete('https://reqres.in/api/users/10');
r.raiseForStatus();
Ignore SSL self-signed certificate
var r = await Requests.get('https://expired.badssl.com/', verify: false);
r.raiseForStatus();
Play with stored cookies
String url = "https://example.com";
await Requests.clearStoredCookies(url);
// Set cookies using [CookieJar.parseCookiesString]
var cookies = CookieJar.parseCookiesString("name=value");
await Requests.setStoredCookies(url, cookies);
// Add single cookie using [CookieJar.parseCookiesString]
var cookieJar = await Requests.getStoredCookies(url);
cookieJar["name"] = Cookie("name", "value");
await Requests.setStoredCookies(url, cookieJar);
// Add a single cookie using [Requests.addCookie]
// Same as the above one but without exposing `cookies.dart`
Requests.addCookie(url, "name", "value");
More examples can be found in example/.