Need help with DavidWebb?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

122 Stars 43 Forks MIT License 55 Commits 9 Opened issues


Lightweight Java HTTP-Client for calling JSON REST-Services (especially for Android)

Services available


Need anything else?

Contributors list

# 26,414
45 commits
# 83,349
1 commit
# 628,802
1 commit
# 702,592
1 commit


Lightweight Java HTTP-Client for calling JSON REST-Services (especially made for Android).


If you have to call a RESTful Webservice from Java, especially if you are on Android, you have some options:

  • Use
    . It is already deployed on Android and it's easy to use. But wait a moment - Google doesn't recommend using it, only on very old Android versions.
  • Use
    . This is what Google recommends for newer Android versions (>= Gingerbread). It is part of JDK, but it's cumbersome to use (if not to say a nightmare).
  • Add
    or some other "all-you-can-eat", universal, multi-part, File-upload and all-cases supporting library which adds some hundred KB of jars to your APK.


DavidWebb is a paper-thin wrapper around HttpURLConnection. It supports most HTTP communication cases when you talk to REST services and your data is JSON. It is very lightweight (~18 KB jar) and super-easy to use.


  • Supports GET, POST, PUT, DELETE
  • add HTTP headers (per request, per client or globally)
  • convert params to
    body or URI search params
  • fluent API
  • org.json support (JSONObject, JSONArray) as payload in both directions (up/down)
  • wraps all Exceptions in a WebbException (a RuntimeException)
  • automatically sets many boiler-plate HTTP headers (like 'Accept', 'Content-Type', 'Content-Length')
  • GZip-compression for uploads (POST/PUT)
  • Un-compress gzip/deflate downloads
  • supports HTTPS and enables relaxing SSL-handshake (self-signed certificates, hostname verification)
  • pass-through to "real" connection for special cases
  • option to retry the request in case of special errors (503, 504, 'connection reset by peer')
  • multi-valued parameters (since 1.3.0)
  • use streams as input and output (automatically closing underlying HttpURLConnection when stream is closed, since 1.3.0)


Following features are not supported and there are no plans to realize them:

  • Cookie management (read
    header from response and set
    header for request). As DavidWebb is just a thin wrapper over HttpURLConnection, you can use
  • Comfortable Basic Authentication (it's not hard to implement it above of DavidWebb, see below)
  • Multi-Part upload
  • Mixing URL-parameters and x-www-form-urlencoded POST bodies.
    Workaround: build the URI with the help of
    and use
    for the form-fields.

Where not stated, the workaround is to use another library or implement it above of DavidWebb. If you think your implementation might be useful for others and it's not blowing up the size of the JAR, please create a pull request. (Adding heavy dependencies is not an option.)

Usage Examples

Below you can see some examples of how to use DavidWebb. And here you can find the API Documentation.

This is some code from a SyncAdapter of an Android App:

// create the client (one-time, can be used from different threads)
Webb webb = Webb.create();
webb.setDefaultHeader(Webb.HDR_USER_AGENT, Const.UA);

// later we authenticate Response response = webb .post("/session") .param("authentication", createAuthentication(syncPreferences)) .param("deviceId", syncPreferences.getDeviceId()) .ensureSuccess() .asJsonObject();

JSONObject apiResult = response.getBody();

AccessToken accessToken = new AccessToken(); accessToken.token = apiResult.getString("token"); accessToken.validUntil = apiResult.getLong("validUntil");

webb.setDefaultHeader(HDR_ACCESS_TOKEN, accessToken.token);

JSONObject sync ="/startSync") .param("lastSync", syncPreferences.getLastSync()) .ensureSuccess() .asJsonObject() .getBody();

// ... etc. etc.

// releaseAccessToken webb.delete("/session").asVoid(); accessToken = null;

Using Google Directions API:

Webb webb = Webb.create();
JSONObject result = webb
        .param("origin", new GeoPoint(47.8227, 12.096933))
        .param("destination", new GeoPoint(47.8633, 12.215533))
        .param("mode", "walking")
        .param("sensor", "true")

JSONArray routes = result.getJSONArray("routes");

Deal with "connection reset by peer" or other recoverable errors

Android (at least >= GINGERBREAD) automatically sets the "Connection" header to "keep-alive". This sometimes causes errors, because the server might already have closed the connection without the mobile device knowing it. It would be cumbersome to cope with this and other situation where a retry solved all problems. Since version 1.2.0 it is more comfortable for you:

Webb webb = Webb.create();
JSONObject result = webb
        .retry(1, false) // at most one retry, don't do exponential backoff

In many cases you will need to change the behaviour of how and when to retry a request. For this, you can register your own

, see

You have to do Basic Authentication?

This authorization method uses a Base64 encoded string. Unfortunately Java SE doesn't provide a Base64 encoder. Because DavidWebb wants to be light and Android already provides a Base64 support class, it's left to you to insert a few lines of code. As you can see, it's not hard work. Use one of the methods to set a header and set Authorization header by yourself:

byte[] credentials = (username + ":" + password).getBytes("UTF-8");
String auth = "Basic " + Base64.encodeToString(credentials, 0);
Webb webb = Webb.create();
webb.setDefaultHeader(Webb.HDR_AUTHORIZATION, auth);

More Samples

If you want to see more examples, just have a look at the JUnit TestCase (src/test/java/...).

Special Case Android < Froyo

You should add this if you build for legacy Android devices:

    System.setProperty("http.keepAlive", "false");

For Android < Lolipop

Solution for TLS1.0 not supported see SSL error #28

First, add dependency for Google Play Services in build file:

implementation ''

Check the Tls version and call installIfNeededAsync(-,-) before calling Webservice: ``` private void checkTls() { if (android.os.Build.VERSION.SDKINT < Build.VERSIONCODES.LOLLIPOP) { try { ProviderInstaller.installIfNeededAsync(this, new ProviderInstaller.ProviderInstallListener() { @Override public void onProviderInstalled() { }

            public void onProviderInstallFailed(int i, Intent intent) {
    } catch (Exception e) {

} ```

In Case Of Problems

I've encountered some problems which could be solved by disabling keep-alive of HTTP connections. The solution above did not always work on recent versions of Android. To be sure to do without keep-alive, you can set an HTTP header like this:

// disable 'keep-alive' for all requests created by this instance of Webb
webb.setDefaultHeader("Connection", "close");

// disable only for this request Request request ="/some-resource").header("Connection", "close");

Maven Coordinates




Not using Maven/Gradle? - Then you can download the plain JAR from following links directly:


Not for you?

If DavidWebb is too lightweight and you're missing features, you can have a look at:

The Name!?

David Webb is the real name of Jason Bourne. So JSON and Web, did you get it? OK, might be silly, but Bourne 1-3 are my favorite films and so at least I can remember the name.

From Wikipedia:

Jason Bourne is a fictional character and the protagonist of a series of novels by Robert Ludlum and subsequent film adaptations


MIT License, see LICENSE file


The Unit-Tests do not mock any network-libraries, but depend on a small Express-application running.

Run following commands before you start the JUnit-tests or skip the tests in Maven build with command line option

cd src/test/api-test-server
npm install
node .

Android Tests

Before running the Android tests, build with maven, deploy the Android app and be sure to set the timezone of your emulator to the same as your PC and synchronize date/time, otherwise some tests will fail:

There is a script (

) which also builds the test-app with gradle.


The test coverage is measured only with the JUnit-tests for JavaSE. As mocking is not easy to accomplish under Android/Dalvik, coverage is not measured for this runtime environment.


Features (planned)

Features (only ideas)

  • provide base classes (or only examples) for using DavidWebb together with
  • decorator/interceptor beforeSend - provide hooks to manipulate request before send
  • decorator/interceptor afterReceive - provide hooks to manipulate raw response after receiving it

Create an issue if you want to have one of those ideas implemented.


  • Create User-Guide


  • Higher coverage
  • Test against


We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.