Retrofit and GET using parameters

Question

I am trying to send a request to the Google GeoCode API using Retrofit. The service interface looks like this:

public interface FooService {         @GET("/maps/api/geocode/json?address={zipcode}&sensor=false")     void getPositionByZip(@Path("zipcode") int zipcode, Callback<String> cb); } 

When I call the service:

OkHttpClient okHttpClient = new OkHttpClient();  RestAdapter restAdapter = new RestAdapter.Builder().setEndpoint(Constants.GOOGLE_GEOCODE_URL).setClient(new OkClient(okHttpClient)).build();  FooService service = restAdapter.create(FooService.class);  service.getPositionByZip(zipCode, new Callback<String>() {     @Override public void success(String jsonResponse, Response response) {        ...     } @Override public void failure(RetrofitError retrofitError) {     } }); 

I receive the following stacktrace:

06-07 13:18:55.337: E/AndroidRuntime(3756): FATAL EXCEPTION: Retrofit-Idle 06-07 13:18:55.337: E/AndroidRuntime(3756): Process: com.marketplacehomes, PID: 3756 06-07 13:18:55.337: E/AndroidRuntime(3756): java.lang.IllegalArgumentException: FooService.getPositionByZip: URL query string "address={zipcode}&sensor=false" must not have replace block. 06-07 13:18:55.337: E/AndroidRuntime(3756):     at retrofit.RestMethodInfo.methodError(RestMethodInfo.java:120) 06-07 13:18:55.337: E/AndroidRuntime(3756):     at retrofit.RestMethodInfo.parsePath(RestMethodInfo.java:216) 06-07 13:18:55.337: E/AndroidRuntime(3756):     at retrofit.RestMethodInfo.parseMethodAnnotations(RestMethodInfo.java:162) 06-07 13:18:55.337: E/AndroidRuntime(3756):     at  

I took a look at the StackOverflow question: Retrofit: multiple query parameters in @GET command? but it did not seem applicable.

I took the code pretty much verbatim from here: http://square.github.io/retrofit/ so I am a bit of a loss to understand the issue.

Thoughts?

Answer 1

AFAIK, {...} can only be used as a path, not inside a query-param. Try this instead:

public interface FooService {          @GET("/maps/api/geocode/json?sensor=false")     void getPositionByZip(@Query("address") String address, Callback<String> cb); } 

If you have an unknown amount of parameters to pass, you can use do something like this:

public interface FooService {          @GET("/maps/api/geocode/json")     @FormUrlEncoded     void getPositionByZip(@FieldMap Map<String, String> params, Callback<String> cb); } 

Answer 2

@QueryMap worked for me instead of FieldMap

If you have a bunch of GET params, another way to pass them into your url is a HashMap.

class YourActivity extends Activity {  private static final String BASEPATH = "http://www.example.com";  private interface API {     @GET("/thing")     void getMyThing(@QueryMap Map<String, String> params, new Callback<String> callback); }  public void onCreate(Bundle savedInstanceState) {    super.onCreate(savedInstanceState);    setContentView(R.layout.your_layout);     RestAdapter rest = new RestAdapter.Builder().setEndpoint(BASEPATH).build();    API service = rest.create(API.class);     Map<String, String> params = new HashMap<String, String>();    params.put("key1", "val1");    params.put("key2", "val2");    // ... as much as you need.     service.getMyThing(params, new Callback<String>() {        // ... do some stuff here.    }); } } 

The URL called will be http://www.example.com/thing/?key1=val1&key2=val2