Android Retrofit2 Retrofit with OkHttp interceptor


Example

This example shows how to use a request interceptor with OkHttp. This has numerous use cases such as:

  • Adding universal header to the request. E.g. authenticating a request
  • Debugging networked applications
  • Retrieving raw response
  • Logging network transaction etc.
  • Set custom user agent
Retrofit.Builder builder = new Retrofit.Builder()
        .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
        .addConverterFactory(GsonConverterFactory.create())
        .baseUrl("https://api.github.com/");

if (!TextUtils.isEmpty(githubToken)) {
    // `githubToken`: Access token for GitHub
    OkHttpClient client = new OkHttpClient.Builder().addInterceptor(new Interceptor() {
        @Override public Response intercept(Chain chain) throws IOException {
            Request request = chain.request();
            Request newReq = request.newBuilder()
                    .addHeader("Authorization", format("token %s", githubToken))
                    .build();
            return chain.proceed(newReq);
        }
    }).build();

    builder.client(client);
}

return builder.build().create(GithubApi.class);

See OkHttp topic for more details.