Develop Reference

Retrofit "form-urlencoded" request with #Field-annotated parameter

I have two queries:
#POST("/auth/login")
suspend fun login(#Body user: LoginUserDto): AuthResponse<TokenDto>
#FormUrlEncoded
#POST("/auth/refresh")
suspend fun refreshToken(#Field("refreshtoken") refreshToken: String): AuthResponse<TokenDto>
The first one is working well which means baseUrl is OK.
The second one returns HTTP 404 Not Found. WHen I look at Chucker interceptor logs, the url is correct and the refreshToken is present in the request. When I try to trigger it manually from request.rest in vsCode like this:
POST http://localhost:4000/auth/refresh/eyJhbGciOiJIUzI1NiIsInR5...blablabla
... it works fine.
The code of the endpoint starts like this (node.js server):
app.post('/auth/refresh/:refreshtoken', async (req, res) => {
const refreshToken = req.params.refreshtoken;
// some code
I believe I made mistake in my retrofit call refreshToken(#Field("refreshtoken") refreshToken: String).
Could smb help how make such #FormUrlEncoded request with retrofit properly?
Appreciate any help.

#Field is used to send #FormUrlEncoded request in Retrofit which hides your parameter and not attach with url to provide security.Used for POST request.
#Query parameter appended to the URL.
If you are using #Field request than it will hides your parameter and not append with the url.
If you are using #Query request than all your parameter is append to your request and visible to users.
Depend on your api request you have to use one of above annotation. If the api request accept the #FormUrlEncoded data than use #Field or if they want to attached it with url than use #Query.

Retrofit POST Request and FormUrlEncoded with :Id in url

I am trying to integrate stripe API and I ran into the problem while using #POST and #FormUrlEncoding annotation.
The stripe has the following Url. https://api.stripe.com/v1/customers/:id/sources
The API need FormUrlEncoded and POST request. I have no idea how to pass that id in the URL.
#POST("https://api.stripe.com/v1/customers/:id/sources")
#FormUrlEncoded
Completable createBankAccount(#Field("source") String bankToken);

You should pass id as a path parameter.
So your endpoint will be as following:
#POST("https://api.stripe.com/v1/customers/{id}/sources")
#FormUrlEncoded
Completable createBankAccount(#Path("id") int id,#Field("source") String bankToken);

How to send request body in get method retrofit

I am using the retrofit library for network calls. In this, I need to pass Body in GET Method. But I am getting the error while I am passing this one. In Postman it is working while passing Body for GET Method.
#GET("http://192.168.0.141:3000/api/contacts/{page_num}/{limit}")
fun getAllContacts(#Path("page_num") page_num:Int,#Path("limit") limit:Int,#Body reqBody:ContactsInpRequest):Call<AllContactsDataResponse>
I am calling get method by passing body. But I am getting the below exception.
java.lang.IllegalArgumentException: Non-body HTTP method cannot contain #Body.

GET method does not contain body like the POST does. Here you can learn more about REST methods: https://restfulapi.net/http-methods/
EDIT: I see that you said that it works in Postman so take a look at this:
*CAN GET request have a body?
In other words, any HTTP request message is allowed to contain a message body, and thus must parse messages with that in mind. Server semantics for GET, however, are restricted such that a body, if any, has no semantic meaning to the request. ... Yes, you can send a request body with GET but it should not have any meaning.*

java.lang.IllegalArgumentException: Non-body HTTP method cannot contain #Body
This means your #GET or #DELETE should not have #Body parameter. You can use query type url or path type url or Query Map to fulfill your need. Else you can use other method annotation.

#Headers("Content-Type: application/json")
#GET("helper-url")
fun getHelperUrl(
#Query("api_token") apiToken: String,
#Query("authtype") authType: String,
#Query("channel") channel: String
): Call<ResponseHelperUrl>

Adding dynamic header to POST request with body (Retrofit v2.4.0)

I am using Retrofit v2.4.0 in my project. I need to get token using one API call and using this token in header of the POST request I should use another API call where I should add one header and two parameter to the body of the request. The following code is of the second API call (JavaRx is used):
#FormUrlEncoded
#POST("auth/sendCode")
#Headers("Content-Type: application/json")
Single<SendCodeResponse> sendCode(#Header("token") String token,
#Field("phoneNumber") String phoneNumber,
#Field("langCode") String langCode);
However, it is not working. When I log my request, it is showing that the request body is not correct.
What is wrong with my code above?

Where in Retrofit build the full JSON before sending it?

I am using retrofit an get Bad Request , I would want to know if there is a place in this library where builds the full JSON in string format before sending it.

If it's about inspecting the JSON at runtime for debugging purposes, you can call setLogLevel(LogLevel.FULL) on your RestAdapter.Builder.
FULL logs the headers, body and metadata for both requests and responses to logcat.

new String(((TypedByteArray) request.getBody()).getBytes());

In order to build a JSON formatted body, create an object with a class whose properties are the same that you want to send to the server. The GSON Library set up (or whichever library you are using) with the RestAdapter should send the request with the body in JSON format.
Also ensure that the call is #POST annotated and the parameter annotd with #Body Below is an example:
#POST("/login")
User login(#Body LoginUser loginUser);