Prestashop - 我的模块的 REST 端点

Posted 2023-02-19

【中文标题】Prestashop - 我的模块的 REST 端点

【英文标题】：Prestashop - REST endpoints for my module

【发布时间】：2018-10-05 23:37:57

【问题描述】：

我正在开发 Prestashop 模块，它将导出客户数据和订单，它将包含用于客户同步、购物车和订单事件的挂钩 - 通常是与类似 CRM 服务的集成模块。

我的模块包含它自己的视图，在 vue.js 中制作 - 单页，异步。有注册、登录、设置等页面。与后端的通信是通过 baseUrl/mymodule/actionname 路由上的 GET/POST 请求和 vue 视图所依赖的简单 json 响应进行的。只需为我的模块创建 REST 端点，如下例所示。

Wordpress 自定义 RestApi：

class RestApi

    public function __construct()
    
        add_action('rest_api_init', array(get_class($this), 
        'register_endpoints'));
    

    public static function register_endpoints()
    
        register_rest_route('mymodule', '/login', array(
            'methods' => WP_REST_Server::CREATABLE,
            'callback' => array('RestApi', 'login' ),
        ));
    

SugarCRM 自定义 RestApi：

class ModuleRestApi extends SugarApi

    public function registerApiRest()
    
        return [
            'moduleLogin' => [
                'reqType' => 'POST',
                'noLoginRequired' => true,
                'path' => [
                    'mymodule', 'login'
                ],
                'method' => 'login'
            ],
        ];
    

我在 PrestaShop 中找不到类似的解决方案，presta 文档中没有关于自定义端点的消息，我尝试使用带有友好 url 的 FrontModuleControllers，但它似乎对我不起作用，它会抛出很多东西作为响应对我来说没用，当我尝试覆盖 init() 方法时，它也需要很多东西才能真正启动控制器。我需要简单的 REST 解决方案，我可以在其中放置用于从我的视图接收数据的逻辑，将其传递给我的 CRM 服务并将 json 响应返回到我的视图。我不需要更多的模板或视图渲染，只需要路由即可。

【参考方案1】：

可以使用 Prestashop Web 服务，它允许从模块中添加资源。这种解决方案可以在标准和安全方面节省一些时间。

有关 Prestashop Webservice 中模块资源的文档在此链接中：

https://webkul.com/blog/creating-prestashop-module-webservice-api/

【参考方案2】：

PrestaShop 不支持此功能。但是，您可以使用模块和前端控制器来做到这一点。

这是一个基本的例子。

1.注册友好 URL 的模块

class RestApiModule extends Module

    public function __construct() 
    
        $this->name = 'restapimodule';
        $this->tab = 'front_office_features';
        $this->version = '1.0';

        parent::__construct();
    

    public function install() 
    
        return parent::install() && $this->registerHook('moduleRoutes');
    

    public function hookModuleRoutes()
    
        return [
            'module-restapimodule-login' => [
                'rule' => 'restapimodule/login',
                'keywords' => [],
                'controller' => 'login',
                'params' => [
                    'fc' => 'module',
                    'module' => 'restapimodule'
                ] 
            ]              
        ];
    

2。创建一个抽象的 REST 控制器

创建一个抽象控制器，以便实际的端点可以从它扩展。在您的模块controllers 文件夹中创建它，然后将其命名为AbstractRestController.php

abstract class AbstractRestController extends ModuleFrontController

    public function init() 
    
        parent::init();
        switch ($_SERVER['REQUEST_METHOD']) 
            case 'GET':
                $this->processGetRequest();
                break;
            case 'POST':
                $this->processPostRequest();
                break;
            case 'PATCH': // you can also separate these into their own methods
            case 'PUT':
                $this->processPutRequest();
                break;
            case 'DELETE':
                $this->processDeleteRequest();
                break;
            default:
                // throw some error or whatever
        
    

    abstract protected function processGetRequest();
    abstract protected function processPostRequest();
    abstract protected function processPutRequest();
    abstract protected function processDeleteRequest();

3。创建一个实际的前端控制器

在您的模块controllers/front 文件夹中创建前端控制器并将其命名为login.php。

require_once __DIR__ . '/../AbstractRestController.php';

class RestApiModuleLoginModuleFrontController extends AbstractRestController

    protected function processGetRequest()
    
        // do something then output the result
        $this->ajaxDie(json_encode([
            'success' => true,
            'operation' => 'get'
        ]));
    

    protected function processPostRequest()
    
        // do something then output the result
        $this->ajaxDie(json_encode([
            'success' => true,
            'operation' => 'post'
        ]));
    

    protected function processPutRequest()
    
        // do something then output the result
        $this->ajaxDie(json_encode([
            'success' => true,
            'operation' => 'put'
        ]));
    

    protected function processDeleteRequest()
    
        // do something then output the result
        $this->ajaxDie(json_encode([
            'success' => true,
            'operation' => 'delete'
        ]));
    

安装模块，现在你可以点击http://example.com/restapimodule/login，根据请求类型，它会做任何你想做的事情，你会得到 JSON 响应。

要添加更多端点，请在 hookModuleRoutes 数组中添加另一个 module-restapimodule-endpointname 条目以及从 AbstractRestController 扩展的前端控制器。

如果您还想要正确的响应代码等，您将不得不使用本机 php 函数设置标头，因为 PrestaShop afaik 没有任何实用程序可以为您执行此操作或使用某种库。

同样适用于您可能想要设置的任何其他标头，例如 content-type（默认为 text/html）。

【讨论】：

谢谢先生！这正是我想要的。

你好@maciey_b 你有这个工作吗？我尝试编写相同的示例，当我尝试点击 /restapimodule/login 时出现“找不到页面”谢谢