Retrofit 2 Multipart POST request sends extra quotes to PHP

Question

Using Retrofit 2.0.1, there is a call function in my API interface defined in Android App:

@Multipart
@POST("api.php")
Call<ResponseBody> doAPI(
  @Part("lang") String lang,
  @Part("file\"; filename=\"image.jpg") RequestBody file
);

I send the request like this:

Call call = service.doAPI("eng", imageFile);

where imageFile is a RequestBody created with a File object. The upload image part has no problem, while the @Part("lang") String lang part got extra quotes in server.

In PHP side, it is written as follow:

$lang = trim($_POST['lang']);

which returns "eng". Why there is an extra double quote surrounded the string?

of course I can strip the trailing and leading double quotes, but it's weird to do so

---

Related Issue: https://github.com/square/retrofit/issues/1210

Answer 1

For your issue, please use as the documentation

Scalars (primitives, boxed, and String): com.squareup.retrofit2:converter-scalars

So, add compile 'com.squareup.retrofit2:converter-scalars:2.0.1' into build.gradle file

Then...

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl(API_URL_BASE)
    .addConverterFactory(ScalarsConverterFactory.create())
    //.addConverterFactory(GsonConverterFactory.create())
    .build();

Hope it helps!

Answer 2

Use RequestBody for all your parameters. Please go through below code!!

File file = new File(imagePath);
RequestBody requestBody = RequestBody.create(MediaType.parse("multipart/form-data"), file);
MultipartBody.Part imageFileBody = MultipartBody.Part.createFormData("media", file.getName(), requestBody);
RequestBody id = RequestBody.create(MediaType.parse("text/plain"),addOfferRequest.getCar_id());
ApiCallback.MyCall<BaseResponse> myCall = apiRequest.editOfferImage(imageFileBody,id);

---

Use RequestBody class of Retrofit instead of String

@Multipart
@POST(ApiURL)
ApiCallback.MyCall<BaseResponse> editOfferImage(@Part MultipartBody.Part imageFile,@Part("id") RequestBody id);

Answer 3

I faced this on my project today and this is how I solved it. I changed @Part on my string and other primitive values to @Query, and for file (in my case image) i used @Part. Looks like @Query treats strings in a different way compared to @Part.

So my answer to original question would look like this:

@Multipart
@POST("api.php")
Call<ResponseBody> doAPI(
  @Query("lang") String lang,
  @Part("file\"; filename=\"image.jpg") RequestBody file
);

This should send string values without unwanted quotes. Sadly, I cant explain why this works, it has something to do with @Part encoding of data.

Answer 4

If you would rather not use a converter, here's what I did to send a multipart request containing an image file, and 2 strings:

@Multipart
@POST("$ID_CHECK_URL/document")
fun postMultipart(@Part imageFile: MultipartBody.Part, @Part string2:  MultipartBody.Part, @Part string2:  MultipartBody.Part)

And calling it this way:

    val body = RequestBody.create(MediaType.parse("image/jpg"), file)
    val imageFilePart = MultipartBody.Part.createFormData("file", file.name, reqFile)

    val string1Part = MultipartBody.Part.createFormData("something", "string 1")

    val string2Part = MultipartBody.Part.createFormData("somethingelse", "string 2")

    service.postDocument(imageFilePart, string1Part, string2Part)