Magento 2 Rest Api получить эскиз изображения URL

12

Как мы получаем URL для миниатюрного изображения продукта через API остальных?

/V1/products/{sku}/media даст нам относительный URL, такой как "/m/b/mb01-blue-0.jpg"

и URL-адрес изображения будет baseurl/catalog/product/m/b/mb01-blue-0.jpg

Это отлично работает. Но как мы получаем эскиз, который обычно находится в папке кеша.

Мохаммед Шамим
источник
Там нет такой функциональности из коробки. Вам придется написать собственный API.
Синиса Неделькович

Ответы:

10

Если вам нужен полный путь к уменьшенному изображению с помощью системы кэширования Magento 2 через API, вы можете создать свой собственный API на основе собственного класса ProductRepository.

Создать новый модуль. (объяснено в других постах)

Создайте файл 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/custom/products/{sku}" method="GET">
        <service class="Vendor\ModuleName\Api\ProductRepositoryInterface" method="get"/>
        <resources>
            <resource ref="Magento_Catalog::products"/>
        </resources>
    </route>
</routes>

Создайте файл etc / di.xml :

<?xml version="1.0"?>
    <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"   xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
    <preference for="Vendor\ModuleName\Api\ProductRepositoryInterface" type="Vendor\ModuleName\Model\ProductRepository" />
</config>

Создайте свой интерфейс Api \ ProductRepositoryInterface.php :

namespace Vendor\ModuleName\Api;

/**
 * @api
 */
interface ProductRepositoryInterface
{
    /**
     * Get info about product by product SKU
     *
     * @param string $sku
     * @param bool $editMode
     * @param int|null $storeId
     * @param bool $forceReload
     * @return \Magento\Catalog\Api\Data\ProductInterface
     * @throws \Magento\Framework\Exception\NoSuchEntityException
     */
    public function get($sku, $editMode = false, $storeId = null, $forceReload = false);
}

Создайте свою модель Model \ ProductRepository.php :

namespace Vendor\ModuleName\Model;


class ProductRepository implements \Magento\Catalog\Api\ProductRepositoryInterface
{
    /**
     * @var \Magento\Catalog\Model\ProductFactory
     */
    protected $productFactory;

    /**
     * @var Product[]
     */
    protected $instances = [];

    /**
     * @var \Magento\Catalog\Model\ResourceModel\Product
     */
    protected $resourceModel;

    /**
     * @var \Magento\Store\Model\StoreManagerInterface
     */
    protected $storeManager;

    /**
     * @var \Magento\Catalog\Helper\ImageFactory
     */
    protected $helperFactory;

    /**
     * @var \Magento\Store\Model\App\Emulation
     */
    protected $appEmulation;

    /**
     * ProductRepository constructor.
     * @param \Magento\Catalog\Model\ProductFactory $productFactory
     * @param \Magento\Catalog\Model\ResourceModel\Product $resourceModel
     * @param \Magento\Store\Model\StoreManagerInterface $storeManager
     */
    public function __construct(
        \Magento\Catalog\Model\ProductFactory $productFactory,
        \Magento\Catalog\Model\ResourceModel\Product $resourceModel,
        \Magento\Store\Model\StoreManagerInterface $storeManager,
        \Magento\Store\Model\App\Emulation $appEmulation,
        \Magento\Catalog\Helper\ImageFactory $helperFactory
    ) {
        $this->productFactory = $productFactory;
        $this->storeManager = $storeManager;
        $this->resourceModel = $resourceModel;
        $this->helperFactory = $helperFactory;
        $this->appEmulation = $appEmulation;
    }


    /**
     * {@inheritdoc}
     */
    public function get($sku, $editMode = false, $storeId = null, $forceReload = false)
    {
        $cacheKey = $this->getCacheKey([$editMode, $storeId]);
        if (!isset($this->instances[$sku][$cacheKey]) || $forceReload) {
            $product = $this->productFactory->create();

            $productId = $this->resourceModel->getIdBySku($sku);
            if (!$productId) {
                throw new NoSuchEntityException(__('Requested product doesn\'t exist'));
            }
            if ($editMode) {
                $product->setData('_edit_mode', true);
            }
            if ($storeId !== null) {
                $product->setData('store_id', $storeId);
            } else {
                // Start Custom code here

                $storeId = $this->storeManager->getStore()->getId();
            }
            $product->load($productId);

            $this->appEmulation->startEnvironmentEmulation($storeId, \Magento\Framework\App\Area::AREA_FRONTEND, true);

            $imageUrl = $this->getImage($product, 'product_thumbnail_image')->getUrl();

            $customAttribute = $product->setCustomAttribute('thumbnail', $imageUrl);

            $this->appEmulation->stopEnvironmentEmulation();

            // End Custom code here

            $this->instances[$sku][$cacheKey] = $product;
            $this->instancesById[$product->getId()][$cacheKey] = $product;
        }
        return $this->instances[$sku][$cacheKey];
    }

    /**
     * Retrieve product image
     *
     * @param \Magento\Catalog\Model\Product $product
     * @param string $imageId
     * @param array $attributes
     * @return \Magento\Catalog\Block\Product\Image
     */
    public function getImage($product, $imageId, $attributes = [])
    {
        $image = $this->helperFactory->create()->init($product, $imageId)
            ->constrainOnly(true)
            ->keepAspectRatio(true)
            ->keepTransparency(true)
            ->keepFrame(false)
            ->resize(75, 75);

        return $image;
    }

}

Доступ

Перейти к /rest/V1/custom/products/{sku}

Вы должны получить уменьшенное изображение с URL-адресом внешнего интерфейса изображения:

<custom_attributes>
    <item>
        <attribute_code>thumbnail</attribute_code>
        <value>http://{domain}/media/catalog/product/cache/1/thumbnail/75x75/e9c3970ab036de70892d86c6d221abfe/s/r/{imageName}.jpg</value>
    </item>
</custom_attributes>

Комментарии :

Третий параметр функции startEnvironmentEmulation используется для принудительного использования области внешнего интерфейса, если вы уже находитесь в том же storeId. (полезно для области API)

Я не тестирую этот пользовательский API, вы можете адаптировать код, но логика верна, но я уже протестировал эту часть для получения URL-адреса изображения в другом пользовательском API.

Этот обходной путь позволяет избежать появления таких ошибок:

http://XXXX.com/pub/static/webapi_rest/_view/en_US/Magento_Catalog/images/product/placeholder/.jpg

Uncaught Magento\Framework\View\Asset\File\NotFoundException: Unable to resolve the source file for 'adminhtml/_view/en_US/Magento_Catalog/images/product/placeh‌​older/.jpg'
Франк Гарнье
источник
Я думаю , что это могло бы работать лучше с \Magento\Catalog\Api\ProductRepositoryInterfaceFactoryвместо \Magento\Catalog\Model\ProductFactory, так как вы можете вызвать get()на productRepositryобъект с SKU непосредственно. По крайней мере, это то, что я сейчас использую.
thaddeusmt
Мы не рекомендуем предоставлять собственный ProductRepositoryInterface, потому что он есть в модуле Catalog. И мы предполагаем, что вы будете настраивать существующий в случае необходимости. Потому что в идеале все клиенты, зависящие от Каталога ProductRepositoryInterface, не должны быть затронуты вашим изменением. Существует два возможных решения для прямой проблемы: 1. Добавить URL-адрес как часть ProductInterface в качестве атрибута расширения 2. Ввести службу выделенного URL-преобразователя. Первое решение не соответствует текущей архитектуре контракта на обслуживание, поскольку этот атрибут должен быть доступен только для чтения.
Игорь Миняйло
Действительно, этот ответ заключается в том, чтобы продемонстрировать возможное решение этой проблемы. Лучшее решение - добавить выделенную службу распознавания URL-адресов и использовать API-интерфейс собственного каталога.
Франк Гарнье
привет @franck Garnier Я получаю сообщение об ошибке, как показано на этом снимке экрана prntscr.com/g5q4ak как решить, пожалуйста, предложите мне спасибо?
Нагараджу К
У вас ошибка явная, функции не существует. Я просто приведу пример кода, но вам нужно адаптировать его к вашим потребностям. Например, реализовать функцию getCacheKey, например, здесь:vendor/magento/module-catalog/Model/ProductRepository.php:258
Франк Гарнье,
2

Причины, по которым Magento не предоставляет эту функциональность из коробки, следующие:

  • Возвращать URL-адрес миниатюрного изображения как часть продукта с атрибутом или атрибутом расширения, что будет означать введение поддержки атрибутов только для чтения (неизменяемых) в объектах данных. Потому что URL является представлением некоторых данных. Данные взяты из разных источников, так как доменное имя относится к конфигурации системы, но путь принадлежит модулю каталога.
  • На данный момент Magento не поддерживает атрибуты или службы только для чтения для Query API.

Как долгосрочное решение - API запросов должны решить этот вопрос, поскольку они предоставят возможность только для чтения и вычисляемых полей. В качестве решения мы могли бы предоставить сообщество в ближайшее время - мы могли бы внедрить / внедрить выделенную службу распознавания URL, которая будет возвращать URL для определенных типов объектов (таких как Product, Category, Image и т. Д.)

По той же причине мы не предоставляем URL продукта как часть ProductInterface

Вот мой ответ, посвященный этой проблеме (URL продукта): https://community.magento.com/t5/Programming-Questions/Retrieving-the-product-URL-for-the-current-store-from-a/mp / 55387 / выделить / правда # M1400

Игорь Миняйло
источник
1
Когда такая служба распознавания URL будет доступна из коробки?
Франк Гарнье
Ответ с 2017 года. Было ли это добавлено в Magenta 2.1.x 2.2.x или 2.3.x с тех пор?
Маркус Уолшон
1

Это должно быть возможно с помощью следующего URL: /rest/V1/products/{sku}

Это вернет продукт, и должен быть узел для custom_attributes, который содержит ссылку на миниатюру

<custom_attributes>
    <item>
        <attribute_code>thumbnail</attribute_code>
        <value>/m/b/mb01-blue-0.jpg</value>
    </item>
</custom_attributes>
DanCarlyon
источник
cache / 1 / thumbnail / 88x110 / beff4985b56e3afdbeabfc89641a4582 / m / b / mb02-blue-0.jpg это расположение миниатюр. есть ли способ получить это?
Мохаммед Шамим
/ V1 / products / {sku} / media и / rest / V1 / products / {sku} дает тот же результат, первый дает только один носитель, а второй - всю другую информацию.
Мохаммед Шамим
@ MohammedShameem вы нашли какое-нибудь рабочее решение?
Torayeff
@torayeff еще нет. Я думаю, придется написать один. Есть ли у вас какие-либо предложения?
Мохаммед Шамим