Retrofit 2 - Dynamic URL

Question

With Retrofit 2  you can set a full URL in the annotation of a service method like     public interface APIService      GET  http   api mysite com user list     Call lt Users gt  getUsers        However  in my app  the URL of my webservices are not known at compile time  the app retrieves them in a downloaded file so i m wondering how i can use Retrofit 2 with full dynamic URL   I tried to set a full path like     public interface APIService      GET   fullUrl      Call lt Users gt  getUsers  Path  fullUrl   fullUrl      new Retrofit Builder      baseUrl  http   api mysite com       build      create APIService class     getUsers  http   api mysite com user list       this url should be dynamic    execute      But here  Retrofit doesn t see that the path is actually a full URL and is trying to download http   api mysite com http 3A 2F 2Fapi mysite com 2Fuser 2Flist  Any hint of how I could use Retrofit with such dynamic url    Thank you

User · Answer

RetrofitHelper library written in kotlin, will let you make API calls, using a few lines of code and you can use different URLs, Headers and Params, in every Call.

Add multiple URLs in your application class like this :

class Application : Application() {

    override fun onCreate() {
    super.onCreate()

        retrofitClient = RetrofitClient.instance
                    //api url
                .setBaseUrl("https://reqres.in/")
                    //you can set multiple urls
        //                .setUrl("example","http://ngrok.io/api/")
                    //set timeouts
                .setConnectionTimeout(4)
                .setReadingTimeout(15)
                    //enable cache
                .enableCaching(this)
                    //add Headers
                .addHeader("Content-Type", "application/json")
                .addHeader("client", "android")
                .addHeader("language", Locale.getDefault().language)
                .addHeader("os", android.os.Build.VERSION.RELEASE)
            }

        companion object {
        lateinit var retrofitClient: RetrofitClient

        }
    }

And then use the URL you need in your call:

retrofitClient.Get<GetResponseModel>()
            //set base url
            .setBaseUrlKey("example")
            //set path
            .setPath("api/users/2")
            //set url params Key-Value or HashMap
            .setUrlParams("KEY","Value")
            .setResponseHandler(GetResponseModel::class.java,
                object : ResponseHandler<GetResponseModel>() {
                    override fun onSuccess(response: Response<GetResponseModel>) {
                        super.onSuccess(response)
                        //handle response
                    }
                }).run(this)

For more information see the documentation

User · Answer

Dynamic URL with Get and Post method in Retrofit  MVVM   Retrofit Service interface   public interface NetworkAPIServices     POST   Observable lt JsonElement gt  executXYZServiceAPI  Url String url  Body AuthTokenRequestModel param      GET Observable lt JsonElement gt  executeInserInfo  Url String url     MVVM service class      public Observable lt JsonElement gt  executXYZServiceAPI ModelObject object        return networkAPIServices authenticateAPI  url               object       public Observable lt JsonElement gt  executeInserInfo String ID        return networkAPIServices getBank DynamicAPIPath mergeUrlPath  url  ID         and Retrofit Client class    Provides  Singleton  Inject  Named  provideRetrofit2   Retrofit provideRetrofit  Named  provideRetrofit2   Gson gson   Named  provideRetrofit2   OkHttpClient okHttpClient         builder   new Retrofit Builder        if  BaseApplication getInstance   getApplicationMode      ApplicationMode DEVELOPMENT            builder baseUrl NetworkURLs BASE URL UAT         else           builder baseUrl NetworkURLs BASE URL PRODUCTION               builder addCallAdapterFactory RxJava2CallAdapterFactory create         builder client okHttpClient       builder addConverterFactory GsonConverterFactory create gson          return builder build        for example This is url   https   gethelp wildapricot com en articles 549-changing-your  baseURL   https   gethelp wildapricot com  Remaining  Url   en articles 549-changing-your  which is you pass in retro service class

User · Answer

I wanted to replace only a part of the url  and with this solution  I don t have to pass the whole url  just the dynamic part   public interface APIService       GET  users  user id  playlists     Call lt List lt Playlist gt  getUserPlaylists  Path value    user id   encoded   true  String userId

User · Answer

As of Retrofit 2 0 0-beta2  if you have a service responding JSON from this URL   http   myhost mypath  The following is not working    public interface ClientService        GET         Call lt List lt Client gt  gt  getClientList       Retrofit retrofit   new Retrofit Builder        baseUrl  http   myhost mypath        addConverterFactory GsonConverterFactory create         build     ClientService service   retrofit create ClientService class    Response lt List lt Client gt  gt  response   service getClientList   execute      But this is ok    public interface ClientService        GET     Call lt List lt Client gt  gt  getClientList  Url String anEmptyString      Retrofit retrofit   new Retrofit Builder        baseUrl  http   myhost mypath        addConverterFactory GsonConverterFactory create         build     ClientService service   retrofit create ClientService class    Response lt List lt Client gt  gt  response   service getClientList     execute

User · Answer

If you already have your code setup and you don   t want to make changes on the different interfaces you can  use the solution described in this link  The main point is the method changeApiBaseUrl that updates the URL and recreates the Retrofit builder   public class ServiceGenerator     public static String apiBaseUrl    http   futurestud io api   private static Retrofit retrofit   private static Retrofit Builder builder           new Retrofit Builder                    addConverterFactory GsonConverterFactory create                     baseUrl apiBaseUrl    private static OkHttpClient Builder httpClient           new OkHttpClient Builder        No need to instantiate this class  private ServiceGenerator        public static void changeApiBaseUrl String newApiBaseUrl        apiBaseUrl   newApiBaseUrl       builder   new Retrofit Builder                        addConverterFactory GsonConverterFactory create                         baseUrl apiBaseUrl      public static  lt S gt  S createService Class lt S gt  serviceClass  AccessToken token        String authToken   token getTokenType   concat token getAccessToken         return createService serviceClass  authToken         more methods            You can use it as follows   public class DynamicBaseUrlActivity extends AppCompatActivity    public static final String TAG    CallInstances   private Callback lt ResponseBody gt  downloadCallback    Override protected void onCreate Bundle savedInstanceState        super onCreate savedInstanceState       setContentView R layout activity file upload        downloadCallback   new Callback lt ResponseBody gt               Override         public void onResponse Call lt ResponseBody gt  call  Response lt ResponseBody gt  response                Log d TAG   server contacted at      call request   url                         Override         public void onFailure Call lt ResponseBody gt  call  Throwable t                Log d TAG   call failed against the url      call request   url                              first request     FileDownloadService downloadService   ServiceGenerator create FileDownloadService class       Call lt ResponseBody gt  originalCall   downloadService downloadFileWithFixedUrl        originalCall enqueue downloadCallback           change base url     ServiceGenerator changeApiBaseUrl  http   development futurestud io api            new request against new base url     FileDownloadService newDownloadService   ServiceGenerator create FileDownloadService class       Call lt ResponseBody gt  newCall   newDownloadService downloadFileWithFixedUrl        newCall enqueue downloadCallback

User · Answer

step - 1   movie list row xml  lt  xml version  1 0  encoding  utf-8   gt   lt LinearLayout xmlns android  http   schemas android com apk res android      android layout width  match parent      android layout height  wrap content      android background   android attr selectableItemBackground      android clickable  true      android focusable  true       android orientation  horizontal      android paddingLeft   dimen activity horizontal margin      android paddingTop   dimen row padding vertical      android paddingRight   dimen activity horizontal margin      android paddingBottom   dimen row padding vertical  gt        lt ImageView         android id    id ivImage          android layout width  60dp          android layout height  60dp          android layout marginRight  10dp          android src   mipmap ic launcher    gt        lt LinearLayout         android layout width  match parent          android layout height  wrap content          android layout weight  1          android orientation  vertical  gt            lt TextView             android id    id title              android layout width  match parent              android layout height  wrap content              android layout alignParentTop  true              android text  Hello              android textColor   color title              android textSize  16dp              android textStyle  bold    gt            lt TextView             android id    id genre              android layout width  match parent              android layout height  wrap content              android layout below   id title              android text  realName    gt       lt  LinearLayout gt        lt TextView         android id    id year          android layout width  wrap content          android layout height  wrap content          android layout alignParentRight  true          android text  Team          android textColor   color year    gt    lt  LinearLayout gt                                                                                                               Api java                                                                                   import org json JSONObject   import java util List   import retrofit2 Call  import retrofit2 Callback  import retrofit2 http Field  import retrofit2 http FormUrlEncoded  import retrofit2 http GET  import retrofit2 http POST   public interface  Api        String BASE URL    https   simplifiedcoding net demos          GET  marvel       Call lt List lt Hero gt  gt  getHeroes          FormUrlEncoded      POST   login       public void login  Field  username   String username   Field  password   String password  Callback lt List lt Hero gt  gt  callback        MoviesAdapter java                                                                                       import android content Context  import android support v7 widget RecyclerView  import android view LayoutInflater  import android view View  import android view ViewGroup  import android widget ImageView  import android widget TextView  import android widget Toast   import com squareup picasso Picasso   import java util List   public class MoviesAdapter extends RecyclerView Adapter lt MoviesAdapter MyViewHolder gt         private List lt Hero gt  moviesList       Context context        public class MyViewHolder extends RecyclerView ViewHolder           public TextView title  year  genre          public ImageView ivImage           public MyViewHolder View view                super view               title    TextView  view findViewById R id title               genre    TextView  view findViewById R id genre               year    TextView  view findViewById R id year               ivImage    view findViewById R id ivImage               ivImage setOnClickListener new View OnClickListener                      Override                 public void onClick View v                         Toast makeText context   -    moviesList get getAdapterPosition    getName    Toast LENGTH SHORT  show                                                            public MoviesAdapter List lt Hero gt  moviesList Context context            this moviesList   moviesList          this context   context              Override     public MyViewHolder onCreateViewHolder ViewGroup parent  int viewType            View itemView   LayoutInflater from parent getContext                     inflate R layout movie list row  parent  false            return new MyViewHolder itemView               Override     public void onBindViewHolder MyViewHolder holder  int position            Hero movie   moviesList get position           holder title setText movie getName             holder genre setText movie getRealname             holder year setText movie getTeam              Picasso get   load  http   i imgur com DvpvklR png   into holder ivImage               Override     public int getItemCount             return moviesList size                                                                                                                                                                   main activity                                                                                                               import android support v7 app AppCompatActivity  import android os Bundle  import android support v7 widget DefaultItemAnimator  import android support v7 widget LinearLayoutManager  import android support v7 widget RecyclerView  import android widget ArrayAdapter  import android widget ListView  import android widget Toast   import java util ArrayList  import java util List   import retrofit2 Call  import retrofit2 Callback  import retrofit2 Response  import retrofit2 Retrofit  import retrofit2 converter gson GsonConverterFactory   public class MainActivity extends AppCompatActivity        private List lt Hero gt  movieList   new ArrayList lt  gt         private RecyclerView recyclerView      private MoviesAdapter mAdapter        Override     protected void onCreate Bundle savedInstanceState            super onCreate savedInstanceState           setContentView R layout activity main            recyclerView findViewById R id recycler view           mAdapter   new MoviesAdapter movieList MainActivity this           RecyclerView LayoutManager mLayoutManager   new LinearLayoutManager getApplicationContext             recyclerView setLayoutManager mLayoutManager           recyclerView setItemAnimator new DefaultItemAnimator             recyclerView setAdapter mAdapter             calling the method to display the heroes         getHeroes                 private void getHeroes             Retrofit retrofit   new Retrofit Builder                    baseUrl ApiInterface BASE URL                   addConverterFactory GsonConverterFactory create      Here we are using the GsonConverterFactory to directly convert json data to object                  build             ApiInterface api   retrofit create ApiInterface class            Call lt List lt Hero gt  gt  call   api getHeroes             call enqueue new Callback lt List lt Hero gt  gt                   Override             public void onResponse Call lt List lt Hero gt  gt  call  Response lt List lt Hero gt  gt  response                    List lt Hero gt  heroList   response body                       Creating an String array for the ListView                 String   heroes   new String heroList size                        looping through all the heroes and inserting the names inside the string array                 for  int i   0  i  lt  heroList size    i                            heroes i    heroList get i  getName                        movieList add new Hero  heroList get i  getName    heroList get i  getRealname    heroList get i  getTeam                                        mAdapter notifyDataSetChanged                                 Override             public void onFailure Call lt List lt Hero gt  gt  call  Throwable t                    Toast makeText getApplicationContext    t getMessage    Toast LENGTH SHORT  show                                       Hero java package com example owner apipractice  public class Hero        private String name      private String realname      private String team       public Hero String name  String realname  String team            this name   name          this realname   realname          this team   team             private String firstappearance      private String createdby      private String publisher      private String imageurl      private String bio        public Hero String name  String realname  String team  String firstappearance  String createdby  String publisher  String imageurl  String bio            this name   name          this realname   realname          this team   team          this firstappearance   firstappearance          this createdby   createdby          this publisher   publisher          this imageurl   imageurl          this bio   bio             public String getName             return name             public String getRealname             return realname             public String getTeam             return team             public String getFirstappearance             return firstappearance             public String getCreatedby             return createdby             public String getPublisher             return publisher             public String getImageurl             return imageurl             public String getBio             return bio

User · Answer

You can use the encoded flag on the  Path annotation   public interface APIService      GET   fullUrl      Call lt Users gt  getUsers  Path value    fullUrl   encoded   true  String fullUrl        This will prevent the replacement of   with  2F  It will not save you from   being replaced by  3F  however  so you still can t pass in dynamic query strings

User · Answer

I think you are using it in wrong way  Here is an excerpt from the changelog      New   Url parameter annotation allows passing a complete URL for an endpoint    So your interface should be like this   public interface APIService        GET     Call lt Users gt  getUsers  Url String url

User · Answer

You can use this        GET  group  id  users        Call lt List lt User gt  gt  groupList  Path  id   int groupId   Query  sort   String sort     For more information see documentation https   square github io retrofit

User · Answer

Step-1     Please define a method in Api interface like -   FormUrlEncoded   POST    Call lt RootLoginModel gt  getForgotPassword           Url String apiname           Field ParameterConstants email id  String username       Step-2            For a best practice define a class for retrofit instance -    public class ApiRequest          static Retrofit retrofit   null     public static Retrofit getClient         HttpLoggingInterceptor logging   new HttpLoggingInterceptor        logging setLevel HttpLoggingInterceptor Level BODY        OkHttpClient okHttpClient   new OkHttpClient   newBuilder                addInterceptor logging               connectTimeout 60  TimeUnit SECONDS               readTimeout 60  TimeUnit SECONDS               writeTimeout 60  TimeUnit SECONDS               build         if  retrofit  null            retrofit   new Retrofit Builder                    baseUrl URLConstants base url                   client okHttpClient                   addConverterFactory GsonConverterFactory create                     build              return retrofit        Step-3               define in your activity -    final APIService request  ApiRequest getClient   create APIService class     Call lt RootLoginModel gt  call   request getForgotPassword  dynamic api    name  strEmailid

[android] Retrofit 2 - Dynamic URL

Examples related to android

Examples related to retrofit