Retrofit 2 - URL Query Parameter

Question

I am using a query parameters to set the values needed by the Google Maps API.

The issue is I do not need the & sign for the first query parameter.

@GET("/maps/api/geocode/json?")
    Call<JsonObject> getLocationInfo(@Query("address") String zipCode,
                                             @Query("sensor") boolean sensor,
                                             @Query("client") String client,
                                             @Query("signature") String signature);

Retrofit generates:

&address=90210&sensor=false&client=gme-client&signature=signkey

which causes the call the fail when I need it to be

address=90210&sensor=false&client=gme-client&signature=signkey

How do I fix this?

Andreas · Accepted Answer · 2016-04-19 22:09:27Z

151

If you specify @GET("foobar?a=5"), then any @Query("b") must be appended using &, producing something like foobar?a=5&b=7.

If you specify @GET("foobar"), then the first @Query must be appended using ?, producing something like foobar?b=7.

That's how Retrofit works.

When you specify @GET("foobar?"), Retrofit thinks you already gave some query parameter, and appends more query parameters using &.

Remove the ?, and you will get the desired result.

answered Apr 19, 2016 at 22:09

Andreas

160k13 gold badges164 silver badges262 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Alan Over a year ago

this works. Do you happen to have any good resources on how urls are structured and all types of parameters? I am not sure what a good keyword to search for.

Andreas Over a year ago

Search for URL, and you'll find en.wikipedia.org/wiki/Uniform_Resource_Locator#Syntax

Andreas Over a year ago

@Arbaz.in Then I suggest you click the "Ask Question" button in the upper right corner.

Magellan · Accepted Answer · 2021-01-20 00:19:48Z

96

I am new to retrofit and I am enjoying it. So here is a simple way to understand it for those that might want to query with more than one query: The ? and & are automatically added for you.

Interface:

 public interface IService {

      String BASE_URL = "https://api.test.com/";
      String API_KEY = "SFSDF24242353434";

      @GET("Search") //i.e https://api.test.com/Search?
      Call<Products> getProducts(@Query("one") String one, @Query("two") String two,    
                                @Query("key") String key)
}

It will be called this way. Considering you did the rest of the code already.

  Call<Results> call = service.productList("Whatever", "here", IService.API_KEY);

For example, when a query is returned, it will look like this.

//-> https://api.test.com/Search?one=Whatever&two=here&key=SFSDF24242353434

Link to full project: Please star etc: https://github.com/Cosmos-it/ILoveZappos

If you found this useful, don't forget to star it please. :)

edited Jan 20, 2021 at 0:19

answered Feb 4, 2017 at 3:08

Magellan

1,2349 silver badges16 bronze badges

4 Comments

Evgeny Fedin Over a year ago

How i can see/log full query string with parametres for requests like this?

Magellan Over a year ago

I am not quite sure how to answer that question. Are you trying to log a method results that has the eg. getProducts so you can see the log? Because you can do that many ways. I don't I have that implemented but here is a project that I have implemented Retrofit awhile back. FYI, not reviewed. github.com/Cosmos-it/ILoveZappos

Hila Grossbard Over a year ago

thank you for just saving me hours over hours! from your github project, I just relized that if I want to add params to my call, I'll need to change the name of my @GET method in my interface to the name of the method in the api I'm trying to use.

Magellan Over a year ago

@HilaGrossbard, you are welcome. I am glad you found this helpful.

Bartek Pacia · Accepted Answer · 2019-07-22 09:10:35Z

21

 public interface IService { 

  String BASE_URL = "https://api.demo.com/";

  @GET("Login") //i.e https://api.demo.com/Search? 
  Call<Products> getUserDetails(@Query("email") String emailID, @Query("password") String password)

}

It will be called this way. Considering you did the rest of the code already.

Call<Results> call = service.getUserDetails("[email protected]", "Password@123");

For example when a query is returned, it will look like this.

https://api.demo.com/[email protected]&password=Password@123

edited Jul 22, 2019 at 9:10

Bartek Pacia

1,8063 gold badges23 silver badges52 bronze badges

answered Nov 22, 2017 at 12:37

Keshav Gera

11.3k1 gold badge78 silver badges56 bronze badges

4 Comments

IgorGanapolsky Over a year ago

Where is authenticateUser defined/

Arbaz.in Over a year ago

i want to pass id at the end like 192.168.1.1/demo/api/memberlist/6557

MoxGeek Over a year ago

@Arbaz.in /memberlist/{id} and set @Path("id") in your function.

behelit Over a year ago

omg you even copied his commented code and forgot to change it

Collectives™ on Stack Overflow

Retrofit 2 - URL Query Parameter

3 Answers 3

3 Comments

4 Comments

4 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

3 Comments

4 Comments

4 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related