{"id":143,"date":"2022-05-09T12:51:35","date_gmt":"2022-05-09T07:21:35","guid":{"rendered":"https:\/\/magecurious.com\/blog\/?p=143"},"modified":"2022-07-11T10:28:43","modified_gmt":"2022-07-11T04:58:43","slug":"magento-2-create-custom-rest-api","status":"publish","type":"post","link":"https:\/\/magecurious.com\/blog\/magento-2-create-custom-rest-api\/","title":{"rendered":"Magento 2 Create Custom Rest API"},"content":{"rendered":"\n

Hello Guys! \ud83d\udc4b<\/p>\n\n\n\n

In this blog, we learn how to create custom rest API calls.<\/p>\n\n\n\n

The REST API is a set of functions that call from request and response using the HTTP response.<\/p>\n\n\n\n

Magento 2 has a much-predefined REST API but in custom development, we need to create a custom REST API in our system.<\/p>\n\n\n\n

So this blog helps you create a custom REST API.<\/p>\n\n\n\n

STEP 1: Add webapi.xml<\/strong> in following path.\n<\/code><\/pre>\n\n\n\n
app\\code\\Vendor\\Extension\\etc<\/code><\/pre>\n\n\n
\n<?xml version="1.0"?>\n<routes xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance" xsi:noNamespaceSchemaLocation="..\/..\/..\/..\/..\/app\/code\/Magento\/Webapi\/etc\/webapi.xsd">\n    <route method="POST" url="\/V1\/custom\/customapi\/">\n        <service class="Vendor\\Extension\\Api\\CustomapiInterface" method="getData"\/>\n        <resources>\n            <resource ref="anonymous"\/>\n        <\/resources>\n    <\/route>\n<\/routes>\n\n<\/pre><\/div>\n\n\n
STEP 2: Add CustomapiInterface.php<\/strong> in following path<\/code><\/pre>\n\n\n\n
app\\code\\Vendor\\Extension\\Api\n<\/code><\/pre>\n\n\n
\n<?php\nnamespace Vendor\\Extension\\Api;\n\ninterface CustomapiInterface\n{\n    \/**\n     * GET for Post api\n     * @param string $data\n     * @return string\n     *\/\n    public function getData($data);\n}\n\n<\/pre><\/div>\n\n\n
STEP 3: Add di.xml<\/strong> in following path\n<\/code><\/pre>\n\n\n\n
app\\code\\Vendor\\Extension\\etc<\/code><\/pre>\n\n\n
\n<?xml version="1.0"?>\n<config xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager\/etc\/config.xsd">\n    <preference for="Vendor\\Extension\\Api\\CustomapiInterface" type="Vendor\\Extension\\Model\\Api\\Customapi"\/>\n<\/config>\n\n<\/pre><\/div>\n\n\n
STEP 4: Now add Customapi.php<\/strong> in following path<\/code><\/pre>\n\n\n\n
app\\code\\Vendor\\Extension\\Model\\Api<\/code><\/pre>\n\n\n
\n<?php\nnamespace Vendor\\Extension\\Model\\Api;\n\nclass Customapi\n{\n    protected $json;\n\n    public function __construct(\n        \\Magento\\Framework\\Serialize\\Serializer\\Json $json\n    ) {\n        $this->json = $json;\n    }\n\n    \/**\n     * @inheritdoc\n     *\/\n    public function getData($data)\n    {\n        $response = ['success' => false];\n        try {\n            \/\/ your custom code\n            $response = ['success' => true, 'message' => $data];\n        } catch (\\Exception $e) {\n            $response = ['success' => false, 'message' => $e->getMessage()];\n        }\n        $returnArray = $this->json->serialize($response);\n        return $returnArray;\n    }\n}\n<\/pre><\/div>\n\n\n
<\/div>\n\n\n\n
Hope! It will help you<\/p>\n\n\n\n
Thank you \ud83d\ude0a<\/p>\n\n\n\n
<\/div>\n\n\n
      
          
        How useful was this post?      <\/p>              
        Click on a star to rate it!      <\/p>        
      
                      
  •               <\/i>          <\/li>                  
  •               <\/i>          <\/li>                  
  •               <\/i>          <\/li>                  
  •               <\/i>          <\/li>                  
  •               <\/i>          <\/li>              <\/ul>    <\/div>    
    <\/p>