Magento2 Orders – Declare @return JSON in API

jsonmagento2orders

I'm playing with M2 API. I built a test module that returns specific Order items in JSON format. I set @return as 'string' (see screenshot below).

Problem: I'm getting error: Class string does not exist.

Question: how should I set @return in phpbloc to get it work properly?

Best Answer

Solution: function returns bunch of Order items so this is how @return should look like:

/**
 * Returns order details 
 *
 * @api
 * @param integer $id Order id.
 * @return \Magento\Sales\Api\Data\OrderItemInterface[]
 */

It will automatically returns then in JSON format.

Related Solutions

Magento – How to return a JSON object with a custom REST API in Magento 2

We can use json_encode with JSON_UNESCAPED_SLASHES:

json_encode($response, JSON_UNESCAPED_SLASHES);

Magento – magento 2 custom api return in json without response tag

Look how Magento 2 handles api response..

class Magento\Framework\Webapi\ServiceOutputProcessor {
...
public function convertValue($data, $type)
{
    if (is_array($data)) {
        $result = [];
        $arrayElementType = substr($type, 0, -2);
        foreach ($data as $datum) {
            if (is_object($datum)) {
                $datum = $this->processDataObject(
                    $this->dataObjectProcessor->buildOutputDataArray($datum, $arrayElementType)
                );
            }
            $result[] = $datum;
        }
        return $result;
    } elseif ...
}

Magento 2 accept array type to response.

$arr = [
    ['name' => 'MasterCard'],
    ['name' => 'VISA'],
    ['name' => 'DBBL-NEXUS'],
    ['name' => 'American Express'],
];
return $arr;

or just..

$arr = '[{"name":"MasterCard"},{"name":"VISA"}, {"name":"DBBL-NEXUS"}, {"name":"American Express"}]';
return json_decode($arr, true);

Best Answer

Related Solutions

Magento – How to return a JSON object with a custom REST API in Magento 2

Magento – magento 2 custom api return in json without response tag

Related Topic