Magento – Magento 2 : REST API response

magento2rest api

I created a custom module to manage new entity. I developed for this module a REST API endpoint to get this entity by ID. My issue is when I'm sending the data I'm using json_encode but it does not send the data as the other default endpoints, how should I send back the data ?

    $attachmentData = [];
    if($attachment->getData()) {
        $attachmentData = [
            'id' => $attachment->getId(),
            'name' => $attachment->getName(),
            'description' => $attachment->getDescription()
        ];
    }

    return json_encode($attachmentData);

Thanks !

Best Answer

Here is an example that may help you. In this example package name is Henote and module name is Store:

step1 : webapi.xml

  <?xml version="1.0" ?>
    <routes xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Webapi:etc/webapi.xsd">
        <route method="GET" url="/V1/store/storeDetails">
            <service class="Henote\Store\Api\StoreManagementInterface" method="getStoreDetails"/>
            <resources>
                <resource ref="anonymous"/>
            </resources>
        </route>    
    </routes>

step2: di.xml

    <?xml version="1.0" ?>
    <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
        <preference for="Henote\Store\Api\StoreManagementInterface" type="Henote\Store\Model\StoreManagement"/>
        <preference for="Henote\Store\Api\Data\StoreDetailsInterface" type="Henote\Store\Model\StoreDetails"/>
    </config>

step3:Henote\Store\Api\StoreManagementInterface.php

    <?php
    namespace Henote\Store\Api;

    interface StoreManagementInterface
    {
        /**
         * GET for getStoreDetails api
         * @param int $id
         * @return \Henote\Store\Api\Data\StoreDetailsInterface
         */
        public function getStoreDetails($id);

    }

step4: Henote\Store\Model\StoreManagement.php

    <?php
    namespace Henote\Store\Model;

    use Henote\Store\Api\StoreManagementInterface;
    use Magento\Framework\ObjectManagerInterface;
    use Henote\Store\Api\Data\StoreDetailsInterfaceFactory;

    class StoreManagement implements StoreManagementInterface
    {

        protected $objectManager;

        protected $storedetailsFactory;


        /**
         * @param ObjectManagerInterface $objectManager     
         * @param StoreDetailsInterfaceFactory $storedetailsFactory
         */
        public function __construct(
            ObjectManagerInterface $objectManager,
            StoreDetailsInterfaceFactory $storedetailsFactory
        ) {
            $this->objectManager = $objectManager;
            $this->storedetailsFactory = $storedetailsFactory;
        }



        /**
         * GET for getStoreDetails api
         * @param int $id
         * @return \Henote\Store\Api\Data\StoreDetailsInterface
         */
        public function getStoreDetails($id){
            $model = $this->objectManager->create('Henote\Store\Model\Store')->load($id);
            $details = $this->storedetailsFactory->create();
            if($model->getId()){
                $details->setId($model->getId());
                $details->setName($model->getName());
                $details->setDescription($model->getDescription());
                return $details;
            }
            else{
                return false;
            }

        }       
    }

step5:Henote\Store\Api\Data\StoreDetailsInterface.php

    <?php
    namespace Henote\Store\Api\Data;

    interface StoreDetailsInterface
    {
        /**
         * Get store id
         * @return int
         */
        public function getId();

        /**
         * Set store id
         * @param int $id
         * @return $this
         */
        public function setId($id);

        /**
         * Get store name
         * @return string|null
         */
        public function getName();

        /**
         * Set store name
         * @param string $name
         * @return $this
         */
        public function setName($name);

        /**
         * Get Description
         * @return string|null
         */
        public function getDescription();

        /**
         * Set Description
         * @param string $description
         * @return $this
         */
        public function setDescription($description);

    }

step6: Henote\Store\Model\StoreDetails.php

    <?php
    namespace Henote\Store\Model;

    use Henote\Store\Api\Data\StoreDetailsInterface;

    class StoreDetails extends \Magento\Framework\Api\AbstractSimpleObject implements StoreDetailsInterface
    {
        const KEY_ID = 'id';
        const KEY_NAME = 'name';
        const KEY_DESCRIPTION = 'description';


        /**
         * Get store id
         * @return int
         */
        public function getId()
        {
            return $this->_get(self::KEY_ID);
        }    

        /**
         * Set store id
         * @param int $id
         * @return $this
         */
        public function setId($id)
        {
            return $this->setData(self::KEY_ID, $id);
        }

        /**
         * Get store name
         * @return string|null
         */
        public function getName()
        {
            return $this->_get(self::KEY_NAME);
        } 

        /**
         * Set store name
         * @param string $name
         * @return $this
         */
        public function setName($name)
        {
            return $this->setData(self::KEY_NAME, $name);
        }

        /**
         * Get Description
         * @return string|null
         */
        public function getDescription()
        {
            return $this->_get(self::KEY_DESCRIPTION);
        } 


        /**
         * Set Description
         * @param string $description
         * @return $this
         */
        public function setDescription($description)
        {
            return $this->setData(self::KEY_DESCRIPTION, $description);
        }
    }

Related Solutions

Magento 2: Sending a Custom Header/Response from a Controller

First of all, to comply with action controller interface \Magento\Framework\App\ActionInterface::execute(), your action must return an instance of \Magento\Framework\Controller\ResultInterface (\Magento\Framework\App\ResponseInterface is also supported, but is legacy and will be removed in future releases of M2, when all core usages are refactored).

So choose from available implementations of \Magento\Framework\Controller\ResultInterface. The most suitable for custom REST API (assuming it operates with JSON) seems to be \Magento\Framework\Controller\Result\Json. However, if you need something even more custom, consider \Magento\Framework\Controller\Result\Raw.

Working sample:

<?php
namespace VendorName\ModuleName\Controller;

/**
 * Demo of authorization error for custom REST API
 */
class RestAuthorizationDemo extends \Magento\Framework\App\Action\Action
{
    /** @var \Magento\Framework\Controller\Result\JsonFactory */
    protected $jsonResultFactory;

    public function __construct(
        \Magento\Framework\App\Action\Context $context,
        \Magento\Framework\Controller\Result\JsonFactory $jsonResultFactory
    ) {
        parent::__construct($context);
        $this->jsonResultFactory = $jsonResultFactory;
    }

    public function execute()
    {
        /** @var \Magento\Framework\Controller\Result\Json $result */
        $result = $this->jsonResultFactory->create();
        /** You may introduce your own constants for this custom REST API */
        $result->setHttpResponseCode(\Magento\Framework\Webapi\Exception::HTTP_FORBIDDEN);
        $result->setData(['error_message' => __('What are you doing here?')]);
        return $result;
    }
}

The code above will result in response with HTTP status code 403 and body {"error_message":"What are you doing here?"}

Magento2 REST API – Fix PUT Customer Fails to Complete

if you look at the documentation you'll find that actually the email is not optional so is needed in order to update the customer

customer-data-customer-interface {
id (integer, optional): Customer id ,
groupId (integer, optional): Group id ,
defaultBilling (string, optional): Default billing address id ,
defaultShipping (string, optional): Default shipping address id ,
confirmation (string, optional): Confirmation ,
createdAt (string, optional): Created at time ,
updatedAt (string, optional): Updated at time ,
createdIn (string, optional): Created in area ,
dob (string, optional): Date of birth ,
email (string): Email address ,
firstname (string): First name ,
lastname (string): Last name ,
middlename (string, optional): Middle name ,
prefix (string, optional): Prefix ,
suffix (string, optional): Suffix ,
gender (integer, optional): Gender ,
storeId (integer, optional): Store id ,
taxvat (string, optional): Tax Vat ,
websiteId (integer, optional): Website id ,
addresses (Array[customer-data-address-interface], optional): Customer addresses. ,
disableAutoGroupChange (integer, optional): Disable auto group change flag. ,
extensionAttributes (customer-data-customer-extension-interface, optional),
customAttributes (Array[framework-attribute-interface], optional): Custom attributes values.
}

but if you try with the email at the current release you'll see there also another param that is not optional (problably the documentation has to be updated). here is the very least needed to do the update:

{
  "customer": {
  "email": "email@here.me",
  "firstname": "firstname new",
  "lastname": "lastname new",
  "website_id": 1
  }
}

Best Answer

Related Solutions

Magento 2: Sending a Custom Header/Response from a Controller

Magento2 REST API – Fix PUT Customer Fails to Complete

Related Topic