How to POST raw whole JSON in the body of a Retrofit request

Question

This question may have been asked before but no it was not definitively answered  How exactly does one post raw whole JSON inside the body of a Retrofit request   See similar question here  Or is this answer correct that it must be form url encoded and passed as a field  I really hope not  as the services I am connecting to are just expecting raw JSON in the body of the post  They are not set up to look for a particular field for the JSON data   I just want to clarify this with the restperts once and for all   One person answered not to use Retrofit  The other was not certain of the syntax  Another thinks yes it can be done but only if its form url-encoded and placed in a field  that s not acceptable in my case    No  I can t re-code all the services for my Android client  And yes  it s very common in major projects to post raw JSON instead of passing over JSON content as field property values   Let s get it right and move on  Can someone point to the documentation or example that shows how this is done  Or provide a valid reason why it can should not be done   UPDATE  One thing I can say with 100  certainty  You CAN do this in Google s Volley  It s built right in  Can we do this in Retrofit

User · Answer

Instead of classes we can also directly use the HashMap lt String  Object gt  to send body parameters for example  interface Foo      POST   jayson     FooResponse postJson  Body HashMap lt String  Object gt  body

User · Answer

I particularly like Jake s suggestion of the TypedString subclass above  You could indeed create a variety of subclasses based on the sorts of POST data you plan to push up  each with its own custom set of consistent tweaks   You also have the option of adding a header annotation to your JSON POST methods in your Retrofit API      Headers   Content-Type  application json     POST   json foo bar    Response fubar   Body TypedString sJsonBody          but using a subclass is more obviously self-documenting    POST   json foo bar   Response fubar   Body TypedJsonString jsonBody

User · Answer

For more clarity on the answers given here  this is how you can use the extension functions  This is only if you are using Kotlin  If you are using com squareup okhttp3 okhttp 4 0 1 the older methods of creating objects of MediaType and RequestBody have been deprecated and cannot be used in Kotlin   If you want to use the extension functions to get a MediaType object and a ResponseBody object from your strings  firstly add the following lines to the class in which you expect to use them   import okhttp3 MediaType Companion toMediaType import okhttp3 RequestBody Companion toRequestBody   You can now directly get an object of MediaType this way  val mediaType    application json  charset utf-8  toMediaType     To get an object of RequestBody first convert the JSONObject you want to send to a string this way  You have to pass the mediaType object to it   val requestBody   myJSONObject toString   toRequestBody mediaType

User · Answer

After so much effort  found that the basic difference is you need to send the JsonObject instead of JSONObject as parameter

User · Answer

The  Body annotation defines a single request body   interface Foo      POST   jayson     FooResponse postJson  Body FooRequest body       Since Retrofit uses Gson by default  the FooRequest instances will be serialized as JSON as the sole body of the request   public class FooRequest     final String foo    final String bar     FooRequest String foo  String bar        this foo   foo      this bar   bar          Calling with   FooResponse   foo postJson new FooRequest  kit    kat       Will yield the following body     foo   kit   bar   kat     The Gson docs have much more on how object serialization works   Now  if you really really want to send  raw  JSON as the body yourself  but please use Gson for this   you still can using TypedInput   interface Foo      POST   jayson     FooResponse postRawJson  Body TypedInput body       TypedInput is a defined as  Binary data with an associated mime type    There s two ways to easily send raw data with the above declaration    Use TypedByteArray to send raw bytes and the JSON mime type   String json       foo     kit     bar     kat      TypedInput in   new TypedByteArray  application json   json getBytes  UTF-8     FooResponse response   foo postRawJson in    Subclass TypedString to create a TypedJsonString class   public class TypedJsonString extends TypedString     public TypedJsonString String body        super body           Override public String mimeType         return  application json           And then use an instance of that class similar to  1

User · Answer

I found that when you use a compound object as  Body params  it could not work well with the Retrofit s GSONConverter  under the assumption you are using that   You have to use JsonObject and not JSONObject when working with that  it adds NameValueParams without being verbose about it - you can only see that if you add another dependency of logging interceptor  and other shenanigans   So what I found the best approach to tackle this is using RequestBody  You turn your object to RequestBody with a simple api call and launch it  In my case I m converting a map       val map   HashMap lt String  Any gt            map  orderType     orderType         map  optionType     optionType         map  baseAmount     baseAmount toString           map  openSpotRate     openSpotRate toString           map  premiumAmount     premiumAmount toString           map  premiumAmountAbc     premiumAmountAbc toString           map  conversionSpotRate      premiumAmountAbc   premiumAmount  toString           return RequestBody create MediaType parse  application json  charset utf-8    JSONObject map  toString      and this is the call     POST  openUsvDeal   fun openUsvDeal           Body params  RequestBody           Query  timestamp   timeStamp  Long           Query  appid   appid  String   Constants APP ID     Call lt JsonObject gt

User · Answer

Add ScalarsConverterFactory to retrofit   in gradle   implementation com squareup retrofit2 converter-scalars 2 5 0    your retrofit   retrofit   new Retrofit Builder                baseUrl WEB DOMAIN MAIN               addConverterFactory ScalarsConverterFactory create                 addConverterFactory GsonConverterFactory create gson                build      change your call interface  Body parameter to String  don t forget to add  Headers  Content-Type  application json      Headers  Content-Type  application json    POST   api getUsers   Call lt List lt Users gt  gt  getUsers  Body String rawJsonString     now you can post raw json

User · Answer

use following to send json  final JSONObject jsonBody   new JSONObject        try            jsonBody put  key    value           catch  JSONException e           e printStackTrace              RequestBody body   RequestBody create okhttp3 MediaType parse  application json  charset utf-8    jsonBody  toString       and pass it to url   Body RequestBody key

User · Answer

Things required to send raw json in Retrofit   1  Make sure to add the following header and remove any other duplicate header  Since  on Retrofit s official documentation they specifically mention-     Note that headers do not overwrite each other  All headers with the   same name will be included in the request     Headers   Content-Type  application json      2  a  If you are using a converter factory you can pass your json as a String  JSONObject  JsonObject and even a POJO  Also have checked  having ScalarConverterFactory is not necessary only GsonConverterFactory does the job    POST   urlPath    FormUrlEncoded Call lt Response gt  myApi  Header  Authorization   String auth   Header  KEY   String key                         Body JsonObject POJO String requestBody     2  b  If you are NOT using any converter factory then you MUST use okhttp3 s RequestBody as Retrofit s documentation says-     The object will also be converted using a converter specified on the   Retrofit instance  If no converter is added  only RequestBody can be   used    RequestBody requestBody RequestBody create MediaType parse  application json  charset utf-8   jsonString     POST   urlPath    FormUrlEncoded Call lt Response gt  myApi  Header  Authorization   String auth   Header  KEY   String key                     Body RequestBody requestBody     3  Success

User · Answer

Based on the top answer  I have a solution to not have to make POJOs for every request   Example  I want to post this JSON          data               mobile     qwer            password     qwer              commom           then  I create a common class like this   import java util Map  import java util HashMap   public class WRequest        Map lt String  Object gt  data      Map lt String  Object gt  common       public WRequest             data   new HashMap lt  gt             common   new HashMap lt  gt               Finally  when I need a json  WRequest request   new WRequest    request data put  type   type   request data put  page   page     The request marked annotation  Body then can pass to Retrofit

User · Answer

In Retrofit2  When you want to send your parameters in raw you must use Scalars   first add this in your gradle   compile  com squareup retrofit2 retrofit 2 3 0  compile  com squareup retrofit2 converter-gson 2 3 0  compile  com squareup retrofit2 converter-scalars 2 3 0    Your Interface  public interface ApiInterface        String URL BASE    http   10 157 102 22 rest          Headers  Content-Type  application json        POST  login       Call lt User gt  getUser  Body String body        Activity     public class SampleActivity extends AppCompatActivity implements Callback lt User gt          Override     protected void onCreate  Nullable Bundle savedInstanceState            super onCreate savedInstanceState           setContentView R layout activity sample            Retrofit retrofit   new Retrofit Builder                    baseUrl ApiInterface URL BASE                   addConverterFactory ScalarsConverterFactory create                     addConverterFactory GsonConverterFactory create                     build             ApiInterface apiInterface   retrofit create ApiInterface class                prepare call in Retrofit 2 0         try               JSONObject paramObject   new JSONObject                paramObject put  email    sample gmail com                paramObject put  pass    4384984938943                 Call lt User gt  userCall   apiInterface getUser paramObject toString                 userCall enqueue this             catch  JSONException e                e printStackTrace                           Override     public void onResponse Call lt User gt  call  Response lt User gt  response                Override     public void onFailure Call lt User gt  call  Throwable t

User · Answer

I tried this  When you are creating your Retrofit instance  add this converter factory to the retrofit builder   gsonBuilder   new GsonBuilder   serializeNulls        your retrofit instance   Retrofit Builder   addConverterFactory  GsonConverterFactory create  gsonBuilder create

User · Answer

Yes I know it s late  but somebody would probably benefit from this  Using Retrofit2  I came across this problem last night migrating from Volley to Retrofit2  and as OP states  this was built right into Volley with JsonObjectRequest   and although Jake s answer is the correct one for Retrofit1 9  Retrofit2 doesn t have TypedString  My case required sending a Map lt String Object gt  that could contain some null values  converted to a JSONObject  that won t fly with  FieldMap  neither does special chars  some get converted   so following  bnorms hint  and as stated by Square   An object can be specified for use as an HTTP request body with the  Body annotation  The object will also be converted using a converter specified on the Retrofit instance  If no converter is added  only RequestBody can be used   So this is an option using RequestBody and ResponseBody  In your interface use  Body with RequestBody public interface ServiceApi        POST  quot prefix user  login  quot       Call lt ResponseBody gt  login  Path  quot login quot   String postfix   Body RequestBody params        In your calling point create a RequestBody  stating it s MediaType  and using JSONObject to convert your Map to the proper format  Map lt String  Object gt  jsonParams   new ArrayMap lt  gt       put something inside the map  could be null jsonParams put  quot code quot   some code    RequestBody body   RequestBody create okhttp3 MediaType parse  quot application json  charset utf-8 quot    new JSONObject jsonParams   toString       serviceCaller is the interface initialized with retrofit create    Call lt ResponseBody gt  response   serviceCaller login  quot loginpostfix quot   body          response enqueue new Callback lt ResponseBody gt                   Override         public void onResponse Call lt ResponseBody gt  call  retrofit2 Response lt ResponseBody gt  rawResponse                        try                              get your response                   Log d TAG   quot RetroFit2 0  RetroGetLogin   quot    rawResponse body   string                               catch  Exception e                                e printStackTrace                                      Override         public void onFailure Call lt ResponseBody gt  call  Throwable throwable                       other stuff                       Hope this Helps anyone   An elegant Kotlin version of the above  to allow abstracting the parameters from the JSON convertion in the rest of your application code  interface ServiceApi        fun login username  String  password  String                jsonLogin createJsonRequestBody                   quot username quot  to username   quot password quot  to password         POST  quot  api login quot       fun jsonLogin  Body params  RequestBody   Deferred lt LoginResult gt       private fun createJsonRequestBody vararg params  Pair lt String  String gt                 RequestBody create                  okhttp3 MediaType parse  quot application json  charset utf-8 quot                     JSONObject mapOf  params   toString

User · Answer

Solved my problem based on TommySM answer  see previous   But I didn t need to make login  I used Retrofit2 for testing https GraphQL API like this    Defined my BaseResponse class with the help of json annotations  import jackson annotation JsonProperty    public class MyRequest        JsonProperty  query       private String query        JsonProperty  operationName       private String operationName        JsonProperty  variables       private String variables       public void setQuery String query            this query   query             public void setOperationName String operationName            this operationName   operationName             public void setVariables String variables            this variables   variables           Defined the call procedure in the interface    POST   api apiname   Call lt BaseResponse gt  apicall  Body RequestBody params    Called apicall in the body of test  Create a variable of MyRequest type  for example  myLittleRequest     Map lt String  Object gt  jsonParams   convertObjectToMap myLittleRequest   RequestBody body         RequestBody create okhttp3 MediaType parse  application json  charset utf-8                         new JSONObject jsonParams   toString     response   hereIsYourInterfaceName   apicall body  execute

User · Answer

API Call  Headers  quot Content-Type  application json quot    POST  quot  set data quot   Call lt CommonResponse gt  setPreferences  Body RequestData request    Note  Use GSON library of Retrofit import com google gson annotations Expose  import com google gson annotations SerializedName   public class RequestData         SerializedName  quot access token quot        Expose     private String accessToken        SerializedName  quot data quot        Expose     private Data data         The above  Data  is another similar class to add inner JSON objects  JSONObject within a JSONObject       public void setAccessToken String accessToken            this accessToken   accessToken             public void setData Data data            this data   data           I guess that will help  rest all integration you might already have had and we don t need anything fancy to use above code snippet  It s working perfectly for me

User · Answer

Add ScalarsConverterFactory create   method and pass hard code

User · Answer

You can use hashmap if you don t want to create pojo class for every API call   HashMap lt String String gt  hashMap new HashMap lt  gt             hashMap put  email   this gmail com            hashMap put  password   1234      And then send like this   Call lt JsonElement gt  register  Body HashMap registerApiPayload

User · Answer

I wanted to compare speed of volley and retrofit for sending and receiving data I wrote below code  for retrofit  part   first dependency   dependencies        implementation  com squareup retrofit2 retrofit 2 4 0       implementation  com squareup retrofit2 converter-gson 2 4 0      Then interface    public interface IHttpRequest        String BaseUrl  https   example com api          POST  NewContract       Call lt JsonElement gt  register  Body HashMap registerApiPayload       and a function to set parameters to post data to server In MainActivity    private void Retrofit         Retrofit retrofitRequest   new Retrofit Builder                baseUrl IHttpRequest BaseUrl               addConverterFactory GsonConverterFactory create                 build            set data to send     HashMap lt String String gt  SendData  new HashMap lt  gt         SendData put  token   XYXIUNJHJHJHGJHGJHGRTYTRY        SendData put  contract type   0        SendData put  StopLess   37000        SendData put  StopProfit   48000         final IHttpRequest request retrofitRequest create IHttpRequest class        request register SendData  enqueue new Callback lt JsonElement gt               Override         public void onResponse Call lt JsonElement gt  call  Response lt JsonElement gt  response                if  response isSuccessful                     Toast makeText getApplicationContext   response body   toString   Toast LENGTH LONG  show                                      Override         public void onFailure Call lt JsonElement gt  call  Throwable t                            And I found Retrofit faster than volley in my case

User · Answer

JSONObject  showing error please use JsonObject paramObject   new JsonObject    paramObject addProperty  quot loginId quot   vMobile Email

User · Answer

Using JsonObject is the way it is     Create your interface like this   public interface laInterfaz        POST   bleh blah org       void registerPayer  Body JsonObject bean  Callback lt JsonObject gt  callback      Make the JsonObject acording to the jsons structure    JsonObject obj   new JsonObject    JsonObject payerReg   new JsonObject    payerReg addProperty  crc   aas22    payerReg addProperty  payerDevManufacturer   Samsung    obj add  payerReg  payerReg     json         payerReg    crc   aas22   payerDevManufacturer   Samsung      json    Call the service    service registerPayer obj  callBackRegistraPagador    Callback lt JsonObject gt  callBackRegistraPagador   new Callback lt JsonObject gt         public void success JsonObject object  Response response           System out println object toString                public void failure RetrofitError retrofitError           System out println retrofitError toString                 And that its  In my personal opinion  its a lot better than making pojos and working with the class mess  This is a lot more cleaner

User · Answer

1 Add dependencies-   compile  com google code gson gson 2 6 2  compile  com squareup retrofit2 retrofit 2 3 0  compile  com squareup retrofit2 converter-gson 2 3 0    2  make Api Handler class       public class ApiHandler       public static final String BASE URL    URL          private static Webservices apiService       public static Webservices getApiService              if  apiService    null                Gson gson   new GsonBuilder                        setLenient                        create                Retrofit retrofit   new Retrofit Builder   addConverterFactory GsonConverterFactory create gson   baseUrl BASE URL  build                 apiService   retrofit create Webservices class               return apiService            else               return apiService                        3 make bean classes from Json schema 2 pojo     Remember   -Target language   Java   -Source type   JSON   -Annotation style   Gson   -select Include getters and setters   -also you may select Allow additional properties   http   www jsonschema2pojo org   4 make  interface  fro api calling      public interface Webservices     POST  ApiUrlpath       Call lt ResponseBean gt  ApiName  Body JsonObject jsonBody           if you have a form-data parameters then add below line    Headers  Content-Type  application x-www-form-urlencoded        Other way for form-data parameter check this link    5 make JsonObject for passing in to body as parameter   private JsonObject ApiJsonMap          JsonObject gsonObject   new JsonObject        try           JSONObject jsonObj    new JSONObject            jsonObj  put  key    value            jsonObj  put  key    value            jsonObj  put  key    value              JsonParser jsonParser   new JsonParser            gsonObject    JsonObject  jsonParser parse jsonObj  toString                print parameter         Log e  MY gson JSON       AS PARAMETER      gsonObject          catch  JSONException e            e printStackTrace               return gsonObject      6  Call Api Like  this  private void ApiCallMethod         try           if  CommonUtils isConnectingToInternet MyActivity this                 final ProgressDialog dialog              dialog   new ProgressDialog MyActivity this               dialog setMessage  Loading                   dialog setCanceledOnTouchOutside false               dialog show                 Call lt ResponseBean gt  registerCall   ApiHandler getApiService   ApiName ApiJsonMap                 registerCall enqueue new retrofit2 Callback lt ResponseBean gt                       Override                 public void onResponse Call lt ResponseBean gt  registerCall  retrofit2 Response lt ResponseBean gt  response                         try                             print respone                         Log e   Full json gson   gt     new Gson   toJson response                            JSONObject jsonObj   new JSONObject new Gson   toJson response  toString                             Log e   responce   gt     jsonObj getJSONObject  body   toString                              if  response isSuccessful                                   dialog dismiss                                int success   response body   getSuccess                                if  success    1                                     else if  success    0                                                                 else                               dialog dismiss                                                        catch  Exception e                            e printStackTrace                            try                               Log e  Tag    error     e toString                                  dialog dismiss                              catch  Resources NotFoundException e1                                e1 printStackTrace                                                                                         Override                 public void onFailure Call lt ResponseBean gt  call  Throwable t                        try                           Log e  Tag    error    t toString                              dialog dismiss                          catch  Resources NotFoundException e                            e printStackTrace                                                                        else               Log e  Tag    error  Alert no internet                      catch  Resources NotFoundException e            e printStackTrace

User · Answer

While creating OkHttpClient that will be used for Retrofit  add an Interceptor like this   private val httpClient   OkHttpClient Builder            addInterceptor  other interceptors                                                              This Interceptor is the main logging Interceptor          addInterceptor   chain - gt              val request   chain request               val jsonObj   JSONObject Gson   toJson request                val requestBody    jsonObj               getJSONObject  quot tags quot                 getJSONObject  quot class retrofit2 Invocation quot                 getJSONArray  quot arguments quot    get 0      quot  quot   toString               val url   jsonObj  getJSONObject  quot url quot    getString  quot url quot       quot  quot                           Timber d  quot gsonrequest request url   url quot               Timber d  quot gsonrequest body   requestBody quot                chain proceed request                                                       Add other configurations          build    Now your every Retrofit call s URL and request body will be logged in Logcat  Filter it by  quot gsonrequest quot

User · Answer

If you don t want to create extra classes or use JSONObject you can use a HashMap   Retrofit interface    POST   rest registration register   fun signUp  Body params  HashMap lt String  String gt    Call lt ResponseBody gt    Call   val map   hashMapOf       username  to username       password  to password       firstName  to firstName       surname  to lastName    retrofit create TheApi  class java        signUp map        enqueue callback

User · Answer

This is what works me for the current version of retrofit 2 6 2   First of all  we need to add a Scalars Converter to the list of our Gradle dependencies  which would take care of converting java lang String objects to text plain request bodies   implementation com squareup retrofit2 converter-scalars 2 6 2    Then  we need to pass a converter factory to our Retrofit builder  It will later tell Retrofit how to convert the  Body parameter passed to the service   private val retrofitBuilder  Retrofit Builder by lazy       Retrofit Builder            baseUrl BASE URL           addConverterFactory ScalarsConverterFactory create             addConverterFactory GsonConverterFactory create           Note  In my retrofit builder i have two converters Gson and   Scalars you can use both of them but to send Json body we need to   focus Scalars so if you don t need Gson remove it   Then Retrofit service with a String body parameter    Headers  Content-Type  application json    POST  users   fun saveUser  Body   user  String   Response lt MyResponse gt    Then create the JSON body  val user   JsonObject    user addProperty  id   001   user addProperty  name    Name     Call your service  RetrofitService myApi saveUser user toString

User · Answer

you need to set  Body in interface  Headers    quot Content-Type  application json charset UTF-8 quot         POST  quot Auth Login quot       Call lt ApiResponse gt  loginWithPhone  Body HashMap lt String  String gt  fields    To pass the raw body to retrofit just use   HashMap lt String String gt  SendData  new HashMap lt  gt             SendData put  quot countryCode quot  ccode           SendData put  quot phoneNumber quot  phone            Call lt ApiResponse gt call   serviceInterface loginWithPhone SendData    this works for me

[android] How to POST raw whole JSON in the body of a Retrofit request?

Examples related to android

Examples related to rest

Examples related to http-post

Examples related to retrofit

Examples related to android-json