I'm trying to learn how to use Retrofit2, and this is the URL I have to generate:
(baseUrl)/repositories?q=language:Python&sort=stars&page=1
This is the method I'm using:
Call<List<Repo>> javaRepos(
#Query("language") String language,
#Query("sort") String sort,
#Query("page") int page
);
and this is how I'm calling it:
Call<List<Repo>> call = client.javaRepos("Python", "stars", 1);
However, this is the url my code generates:
(baseUrl)/repositories?language=Python&sort=stars&page=1
The differences are:
the q= is missing;
language is followed by a = instead of a :
How can I generate the correct url using #Query parameters (or any other way, actually)?
Looks like you're misinterpreting the query string of your desired url.
q=language:Python&sort=stars&page=1 should be broken down into three key-value pairs:
q - language:Python
sort - stars
page - 1
Note that the first key is q and not language.
With that in mind, your method should look like this (and you'll have to pass "language:Python" instead of just "Python" as the first argument).
Call<List<Repo>> javaRepos(
#Query("q") String language,
#Query("sort") String sort,
#Query("page") int page
);
You need to use Path annotation according to this link : https://square.github.io/retrofit/2.x/retrofit/index.html?retrofit2/http/Path.html
#GET("repositories?q=language:{lang}&sort={sort}&page={page}")
Call<List<Repo>> javaRepos(#Path(value = "lang") String lang, #Path(value = "sort") String sort, #Path(value = "page") int page);
Related
I am not able to add special character "&" in my endpoint of the URL.
Here is my api interface
#GET("api/v1/products/artworks/")
Call<TaskData> getLatestTaskData(#Header("Authorization") String token,
#Query("limit") Integer limit,
#Query("offset") String offset);
URL that is getting called
artworks/?limit=50&offset=0%26ordering%3D-artwork
And this is how I am calling the api
String url = Integer.toString(totalitemsCalledLatest) +"&ordering="+ ordering;
Call<TaskData>
call = taskApiInterface.getLatestTaskData("Token "+ user_token, 50, url);
My ordering string is something like &medium=1&base=2
But it converts automatically & to %26 and = to %3D
edit: assuming you are having connection problems to the api, i think you just need to remove the '/' from the end of your GET URL, like this: api/v1/products/artworks or at least that is one solution that will help you get closer to fixing your problem
I was thinking which should be the preferred way of defining endpoints in Retrofit2 for pagination.
Should we separate the endpoints or should we define only one endpoint method and pass page=null?
#GET("/search/users")
Observable<FetchUserResponse> fetchUsers(#Query("q") String uname,
#Query("sort") String followerspage);
#GET("/search/users")
Observable<FetchUserResponse> fetchUsersPaginationCall(#Query("q") String uname,
#Query("sort") String followerspage,
#Query("page") int page);
or
#GET("/search/users")
Observable<FetchUserResponse> fetchUsers(#Query("q") String uname,
#Query("sort") String followers,
#Query("page") String page);
Adjustments must happen on the API itself, it must set a default on a page if it is null or missing on the query param. You should define one end point only for this.
I want to customizer my endPoint using Retrofit2 on Android but I have a doubt.
If I do that:
#GET("Search") //i.e https://api.test.com/Search?
Call<Products> getProducts(#Query("one") String one, #Query("two") String two,
#Query("key") String key)
My endPoint could be like this:
//-> https://api.test.com/Search?one=Whatever&two=here&key=SFSDF24242353434
I'm working with this endPoint:
// -> https://example.com/third-party-public/categories/category_id.json
If I use the same ideia as I explained above the result can be is:
#GET("/third-party-public/categories/")
Observable<List<Category>> getCategoryDetail(#Query(".json") String category_id);
The result could be:
// -> https://example.com/third-party-public/categories/.json=1
But I want that result
// -> https://example.com/third-party-public/categories/1.json
How can I setting my #query for get that result?
#GET("/third-party-public/categories/{category_id}.json")
Observable<List<Category>> getCategoryDetail(#Path("category_id") String category_id);
If you set a request with query it sets as query param '?'.
If the result you want is that you simply use it as in path:
#GET("Search/{fileUri}")
Call<Products> getProducts(#Path("fileUri") String fileUri);
You get the value it as "1.json".
Hi all i call below URL using Retrofit
https://api.stackexchange.com/2.2/me?key=gQJsL7krOvbXkJ0NEI((&site=stackoverflow&order=desc&sort=reputation&access_token=HM*22z8nkaaoyjA8))&filter=default
and for that i created Interface RestInterface
//get UserId
#GET("/me&site=stackoverflow&order=desc&sort=reputation&access_token={access_token}&filter=default")
void getUserId(#Query("key") String apikey,#Path("access_token") String access_token,Callback<UserShortInfo> cb);
When i do this it always add key at the end of the URL(Output below).
I added #Query("key") as Query Parameter becoz it's dynamic.
http://api.stackexchange.com/2.2/me&site=stackoverflow&order=desc&sort=reputation&access_token=p0j3dWLIcYQCycUHPdrA%29%29&filter=default?key=gQJsL7krOvbXkJ0NEI%28%28
and that's the wrong. I got HTTP 400. Also here (( and )) converted into %28%28 and %29%29
Please help me how to make
https://api.stackexchange.com/2.2/me?key=gQJsL7krOvbXkJ0NEI((&site=stackoverflow&order=desc&sort=reputation&access_token=HM*22z8nkaaoyjA8))&filter=default
in Retrofit. I want it add #Query parameter in between URL. not at the end of the URL
Don't put query parameter inside the URL only the path parameter you can add
#GET("/me?site=stackoverflow&order=desc&sort=reputation&filter=default)
void getUserId(#Query("key") String apikey,#Query("access_token") String access_token,Callback<UserShortInfo> cb);
#Query("access_token") --> given key and value will come query URL
While sending request your URL form will like below
/me?key=?site=stackoverflow&order=desc&sort=reputation&filter=default&"your_value"&access_token="your_value"
obviously instead
#GET("/me&site=stackoverflow&order=desc&sort=reputation&access_token={access_token}&filter=default")
void getUserId(#Query("key") String apikey,#Path("access_token") String access_token,Callback<UserShortInfo> cb);
you should use
#GET("/me?site=stackoverflow&order=desc&sort=reputation&filter=default")
void getUserId(#Query("key") String apikey,#Query("access_token") String access_token,Callback<UserShortInfo> cb);
the chanege is /me& to /me? ... (and second is to use access_token as Query param too, not as a Path)
edit more explanations:
After parsing url which looks like (me&)
scheme:host/me&blablalbal=blalbla&blabla=blabla
the path is
me&blablalbal=blalbla&blabla=blabla
and there is no query paramas at all ... so adding params end with adding ?param=value at the end
but with (me?)
scheme:host/me?blablalbal=blalbla&blabla=blabla
the path is
me
and there are already some query parameters ... so addin new end with adding ¶m=value at the end :)
I'd like to perform batch request using Retrofit. It there any nice way, how to achieve it? Basically what I'm trying to do is to replace some characters in query part of URL (replace block is allowed only in path part of URL - using #Path annotation).
Here is a pseudocode for my problem.
#GET("/v2/multi?requests=/users/self,/venues/search?client_id={client_id}&client_secret={client_secret}&v={v}&ll={ll}&intent={intent}&limit={limit}")
ProfileSearchVenuesResponse searchVenuesAndProfiles(#ReplaceBy("client_id") String clientId,
#ReplaceBy("client_secret") String clientSecret,
#ReplaceBy("v") int version,
#ReplaceBy("ll") String location,
#ReplaceBy("intent") String intent,
#ReplaceBy("limit") int limit);
#Query is what you are looking for:
#GET("/v2/multi?requests=/users/self,/venues/search")
ProfileSearchVenuesResponse searchVenuesAndProfiles(
#Query("client_id") String clientId,
#Query("client_secret") String clientSecret,
#Query("v") int version,
#Query("ll") String location,
#Query("intent") String intent,
#Query("limit") int limit);
In version 1.7.0 of Retrofit (released yesterday) the exception message for attempting to use #Path in the original question instructs you as to the right solution:
URL query string "client_id={client_id}&client_secret={client_secret}&v={v}&ll={ll}&intent={intent}&limit={limit}" must not have replace block. For dynamic query parameters use #Query.