Is it correct to pass json as string

Question

I have doubt is it correct/acceptable technique to pass json as string parameter to the API? Is there any implication while passing json as string variable to the API method? i mean normally json will be like this {"blkHouseNo":"11","streetName":"Beach ROAD","postalCode":"123456","storeyNo":"22","unitNo":"2",} but I want to pass as {"PayLoad":"{\"blkHouseNo\":\"183\",\"streetName\":\"Beach ROAD\",\"postalCode\":\"123456\",\"storeyNo\":\"22\",\"unitNo\":\"2\"}"} is it right way ? Currently Any API's following this approach? just asking for prof for the concept to convey to the higher management

Vivek Kumar · Answer

Hi Hari, Yes, i t is allowed to pass json as string value but you have to understand the pros and cons .

Hari Babu · Answer

Hi Vivek, Thanks for reply . I am doing deserializing the Payload filed in back end after recieve the request and able to do the validation and saving . But is it allowed to pass json as string value ?.Please help to confirm . Thanks for your support

Vivek Kumar · Answer

Hi Hari, I don't thnk so it is correct way to pass as a string because you can't keep validation in API level or correct format if you pass as a string and at the same time if you want to do any operation (saving or updating in Database) then it is not recommended to do because again you have to write bunch of code for manupalate the data.

Hari Babu · Answer

HI Rajesh Proposed example will not suit for me . my question here for post method json passing as nested string as below . in the below example "Payload" field having another json as value my question here weather below way is recomonded or not ? is there any API's using this approch? {"PayLoad":"{\"blkHouseNo\":\"183\",\"streetName\":\"Beach ROAD\",\"postalCode\":\"123456\",\"storeyNo\":\"22\",\"unitNo\":\"2\"}"} Please advice

Rajeesh Menoth · Answer

Hi, Please check the similar thread in Stack : https://stackoverflow.com/questions/50850318/rest-api-passing-json-string-as-parameter-value