Categories: Magento News

How to create a custom API in Magento 2

I. Application Programming Interface

API (Application Programming Interface) is an extremely important part of systems in general and Magento 2 in particular. We will learn the way to create a custom API in Magento 2.

We need a tool to interact with the API, we will use Postman, one of the most popular tools.

You can try to Download

II. The way to create a custom API in Magento 2

First of all, we will create a new module with the following directory structure:

Firstly, we must define the API in etc/webapi.xml as below:

In there:

  • Route:
    + method: the way to get data, can be GET or POST
    + URL: Link address
  • Service:
    + class: link of the handler class
    + method: which method to handle this request
  • Method

Next, we need to create an interface class  as Api/FirstApiInterface.php:

The Mode/firstApi.php has the below content:

Finally, we need to create a preference at etc/di.xml as follow: 

We need to run the following commands for the module to work: 

  • bin/magento setup:upgrade
  • bin/magento setup:di:compile
  • bin/magento cache:flush

To verify the result, we create a request in Postman with its URL: 

https://localhost/rest/all/V1/landofcode-firstapi/hello?name=LandofCode

The results response: 

Good luck to you!

Read more:

Joe Kun

Recent Posts

Data-Driven Personalization Magento: How AI Dramatically Enhances Extensions

Generic online stores fail to convert visitors. They offer the same experience to every individual.…

1 day ago

Top 10 Extensions Every SEO Expert Must Use in 2025

If you’ve been in the SEO game for more than five minutes, you know one…

2 days ago

Magento 2 PWA Extensions: Top Modules for Progressive Web App Development

Your customers are on the go. They want speed and demand a seamless experience. A…

4 days ago

7 Game-Changing Digital Tools for Chiropractors in 2025

Running a chiropractic practice today means balancing patient care with the demands of scheduling, billing,…

5 days ago

Powerful Custom Email Design Strategies to Build Trust and Recognition in 2025

Custom email design is no longer just about aesthetics—it’s a powerful tool for building trust,…

5 days ago

Powerful Reasons Why Marketo Email Marketing Automation is the Best Choice in 2025

Marketo email marketing automation is redefining how email professionals and agencies operate in 2025. So,…

5 days ago