Magento 2 - How to return custom json response from API

Question

I'm working with Magento 2 API and I'm really struggled with response of it

How can I return some kind of response like this:

{
 "status": 200,
 "error": false,
 "message": "Request processed successfully.",
 "data": {
 "id": "1",
 "email": "[email protected]",
 "first_name": "user1",
 "last_name": "user01"
 }
}

It's simple with other framework like Laravel or Express. But it seems really hard to achieve this with Magento 2 API.

Anyone has idea? Thank you.

• PY Yick: Give you a reference first, you can edit the format as you like: magento.stackexchange.com/questions/92105/…
• 0xh8h: Thank you. But did you try this? I tried, at the moment, this interface has only one method left, it is sendResponse. And it seems not work as we expected
• PY Yick: I didn't try as I don't need to do so, just a reference for you.
• Nagaraju Kasa: have u found any solution for this in magento2?
• 0xh8h: @NagarajuKasa: No, I didn't find the kind of solution I needed. And I had to use response format that Magento team force us to use :)

Answer 1

First you need to define the interface/class of the result type. The interface will look like this.

namespace Vnecoms\SampleAPI\Api;
interface Result
{
 /**
 * @return int
 */
 public function getStatus();
 /**
 * @return bool
 */
 public function getError();
 /**
 * @return string
 */
 public function getMessage();
 /**
 * @return \Vnecoms\SampleAPI\Api\ResultData
 */
 public function getData();
}

Next is the ResultData interface

namespace Vnecoms\SampleAPI\Api;
interface ResultData
{
 /**
 * @return int
 */
 public function getId();
 /**
 * @return string
 */
 public function getEmail();
 /**
 * @return string
 */
 public function getFirstName();
 /**
 * @return string
 */
 public function getLastName();
}

Now in your API just return an object of \Vnecoms\SampleAPI\Api\Result

• anon: how to return it?
• Hungvt: I write down the interface only. You will need to define your own class follows the interface above.
• Pini: @Hungvt, Is it possible to build that data interface without a getter method for every field? (What can you do when you have, for example, 200 fields? or dynamic number of fields?)
• domdambrogia: This is a terrible answer. This doesn't explain anything other than how to create an interface for a few necessary fields.