Как создать собственный REST API эндпоинт

Pimcore предлагает пакет под названием DataHub, который предоставляет гибко настраиваемый интерфейс GraphQL для большинства сущностей Pimcore.

Однако часто при разработке приложений на базе Pimcore возникает задача интеграции с внешними системами, которым требуются специфические ответы от API-эндпоинтов.

Один из способов реализации этого требования — создание собственного экшена контроллера, который будет отдавать только нужные данные в требуемом формате.

Пример

<?php  
  
namespace App\Controller;  
  
use Pimcore\Model\DataObject;  
use Symfony\Component\HttpFoundation\JsonResponse;  
use Symfony\Component\HttpFoundation\Request;  
use Symfony\Component\Routing\Annotation\Route;  
use \Pimcore\Controller\FrontendController;  
  
class CustomRestController extends FrontendController  
{  
    /**  
     * @Route("/custom-pimcore-webservice/rest/get-products")  
     */  
    public function defaultAction(Request $request): JsonResponse  
    {  
        // Здесь необходимо реализовать вашу логику авторизации ...  
  
        $blogs = new DataObject\BlogArticle\Listing();  
  
        foreach ($blogs as $key => $blog) {  
            $data[] = array(  
                "title" => $blog->getTitle(),  
                "description" => $blog->getText(),  
                "tags" => $blog->getTags());  
        }  
  
        return $this->json(["success" => true, "data" => $data]);  
    }  
}  
  

Иногда требуется сериализовать весь элемент целиком для ответа API. Это можно сделать путем переопределения модели объекта данных. Вам необходимо реализовать интерфейс \JsonSerializable и метод jsonSerialize, чтобы возвращать именно те данные, которые должны быть сериализованы.

<?php  
  
namespace App\Model\DataObject;  
  
class BlogArticle extends \Pimcore\Model\DataObject\BlogArticle implements \JsonSerializable  
{  
    public function jsonSerialize(): array  
    {  
        $vars = get_object_vars($this);  
  
        return $vars;  
    }  
}