1. Overview
In this short tutorial, we’ll learn how to create a dynamic URL in Retrofit2.
2. @Url Annotation
There are cases when we need to use a dynamic URL in our application during runtime. Version 2 of the Retrofit library introduced the @Url annotation that allows us to pass a complete URL for an endpoint:
@GET
Call<ResponseBody> reposList(@Url String url);
This annotation is based on the HttpUrl class from OkHttp’s library, and the URL address is solved like a link on a page using . When using the @Url parameter, we don’t need to specify the address in the @GET annotation.
The @Url parameter replaces our baseUrl from the service implementation:
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("https://api.github.com/")
.addConverterFactory(GsonConverterFactory.create()).build();
What is important is that if we want to use the @Url annotation, it must be set as the first parameter in the service method.
3. Path Param
If we know that some part of our base URL will be constant, but we don’t know the extension of it or the number of parameters that will be used, we can use the @Path* annotation and the *encoded flag:
@GET("{fullUrl}")
Call<List<Contributor>> contributorsList(@Path(value = "fullUrl", encoded = true) String fullUrl);
This way, all “/” won’t be replaced by %2F, as if we had not used the encoded parameter. However, all characters “?” in the passed address still will be replaced by %3F*.*
4. Summary
The Retrofit library allows us to easily provide a dynamic URL during application runtime by using only the @Url annotation.