How to Implement Get List Web API Endpoint in Magento 2

In today’s digital era, eCommerce has become a booming industry, and the demand for seamless integration and efficient data management has never been higher. Magento 2, a popular eCommerce platform, offers a robust API (Application Programming Interface) system that allows developers to interact with and manipulate data within the system. One essential aspect of creating a successful eCommerce website is the ability to retrieve a list of items or products via a web API. In this blog post, we’ll walk you through the process of implementing a “Get List” Web API endpoint in Magento 2.

Prerequisites:

Before diving into the implementation, ensure you have the following prerequisites in place:

• A working Magento 2 installation.
• Basic knowledge of PHP and Magento 2 development.
• A code editor of your choice.

Step 1: Define the Web API Endpoint

In Magento 2, API endpoints are defined in the webapi.xml file of your module. Here’s an expanded version of the XML file to define the “Get List” endpoint:

<!-- app/code/YourCompany/YourModule/etc/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 url="/V1/yourmodule/items" method="GET">
        <service class="YourCompany\YourModule\Api\YourItemInterface" method="getList"/>
        <resources>
            <resource ref="anonymous"/>
        </resources>
    </route>
</routes>

In this XML snippet:

• url: Specifies the endpoint URL. /V1/yourmodule/items will be the URL to access the “Get List” endpoint.
• method: Defines the HTTP method for this endpoint. In this case, it’s a GET request.
• service: Points to the API interface class (YourItemInterface) and the method (getList) that will handle the request.
• resources: Defines the permissions for accessing this endpoint. In this example, it’s set to anonymous, allowing public access.

Step 2: Create the API Interface

Now, let’s create the YourItemInterface interface in your module’s Api directory:

// app/code/YourCompany/YourModule/Api/YourItemInterface.php

namespace YourCompany\YourModule\Api;

interface YourItemInterface
{
    /**
     * Retrieve a list of items.
     *
     * @return \YourCompany\YourModule\Api\Data\YourItemInterface[]
     */
    public function getList();
}

In this interface:

• We define the getList method, which will return an array of YourItemInterface objects.

Step 3: Implement the API Interface

Create a class that implements the YourItemInterface. This class will contain the logic to retrieve the list of items:

// app/code/YourCompany/YourModule/Model/YourItem.php

namespace YourCompany\YourModule\Model;

use YourCompany\YourModule\Api\YourItemInterface;
use YourCompany\YourModule\Model\ResourceModel\YourItem\CollectionFactory;

class YourItem implements YourItemInterface
{
    protected $itemCollectionFactory;

    public function __construct(
        CollectionFactory $itemCollectionFactory
    ) {
        $this->itemCollectionFactory = $itemCollectionFactory;
    }

    /**
     * {@inheritdoc}
     */
    public function getList()
    {
        $itemCollection = $this->itemCollectionFactory->create();
        return $itemCollection->getItems();
    }
}

Here’s what’s happening in this class:

• We inject a CollectionFactory to create a collection of items.
• The getList method fetches items from the collection and returns them.

Step 4: Create a Data Interface

To define the structure of the items, create a data interface:

// app/code/YourCompany/YourModule/Api/Data/YourItemInterface.php

namespace YourCompany\YourModule\Api\Data;

interface YourItemInterface
{
    /**
     * Get Item ID.
     *
     * @return int
     */
    public function getId();

    /**
     * Get Item Name.
     *
     * @return string
     */
    public function getName();

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

    /**
     * Set Item Name.
     *
     * @param string $name
     * @return $this
     */
    public function setName($name);
}

This interface defines the structure of the items, including their ID and name.

Step 5: Implement the Data Model

Create a data model class that implements the YourItemInterface:

// app/code/YourCompany/YourModule/Model/Data/YourItem.php

namespace YourCompany\YourModule\Model\Data;

use YourCompany\YourModule\Api\Data\YourItemInterface;

class YourItem extends \Magento\Framework\Api\AbstractExtensibleObject implements YourItemInterface
{
    const ID = 'id';
    const NAME = 'name';

    /**
     * {@inheritdoc}
     */
    public function getId()
    {
        return $this->_get(self::ID);
    }

    /**
     * {@inheritdoc}
     */
    public function getName()
    {
        return $this->_get(self::NAME);
    }

    /**
     * {@inheritdoc}
     */
    public function setId($id)
    {
        return $this->setData(self::ID, $id);
    }

    /**
     * {@inheritdoc}
     */
    public function setName($name)
    {
        return $this->setData(self::NAME, $name);
    }
}

This data model class implements the YourItemInterface and provides getters and setters for item ID and name.

Step 6: Implement the Resource Model

Create a resource model that interacts with the database and retrieves the list of items:

//app/code/YourCompany/YourModule/Model/ResourceModel/YourItem/Collection.php

namespace YourCompany\YourModule\Model\ResourceModel\YourItem;

use Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection;
use YourCompany\YourModule\Model\YourItem as YourItemModel;
use YourCompany\YourModule\Model\ResourceModel\YourItem as YourItemResourceModel;

class Collection extends AbstractCollection
{
    protected $_idFieldName = 'id';

    /**
     * Define model & resource model
     */
    protected function _construct()
    {
        $this->_init(YourItemModel::class, YourItemResourceModel::class);
    }
}

This collection class specifies the model and resource model for your items. It is used by the YourItem model to fetch the list of items.

Step 7: Test the API Endpoint

To test the API endpoint, make sure your module is enabled:

php bin/magento module:enable YourCompany_YourModule
php bin/magento setup:upgrade

After enabling the module, use a tool like Postman or cURL to make a GET request to your endpoint:

GET http://yourmagentourl/rest/V1/yourmodule/items

This request should return a JSON response containing the list of items.

By following these detailed code examples, you can successfully implement a “Get List” Web API endpoint in Magento 2. This endpoint allows you to retrieve a list of items or products from your eCommerce website, making it more accessible and efficient for external systems to interact with your store’s data.Implementing a “Get List” Web API endpoint in Magento 2 involves defining the endpoint, creating the necessary interfaces, models, and resource models, and then testing the API to ensure it works as expected. With the steps outlined in this blog post, you’ll be able to retrieve lists of items or products seamlessly, making your eCommerce website more efficient and user-friendly. Magento 2’s flexible API system allows for a wide range of customization and integration possibilities, making it a powerful platform for building eCommerce solutions.